GhosttySnapshotDecoderOption enum

Configurable snapshot decoder options.

Options may only be changed before decoding starts. Calling ghostty_snapshot_decoder_set() after ghostty_snapshot_decoder_ready() or ghostty_snapshot_decoder_decode() returns GHOSTTY_INVALID_VALUE.

Inheritance
Available extensions

Values

GHOSTTY_SNAPSHOT_DECODER_OPT_MAX_CONTINUATION_BYTES → const GhosttySnapshotDecoderOption

Largest non-ground continuation the decoder will accept.

A value of zero accepts only snapshots whose VT parser is in the ground state. The decoder default matches the largest built-in APC protocol buffer limit, currently 65 MiB.

This is primarily an input validation limit. When GHOSTTY_SNAPSHOT_DECODER_OPT_RETAIN_CONTINUATION is true, the same value also becomes the continuation tracking limit on the returned terminal.

Input type: size_t *

const GhosttySnapshotDecoderOption(0)
GHOSTTY_SNAPSHOT_DECODER_OPT_RETAIN_CONTINUATION → const GhosttySnapshotDecoderOption

Retain the decoded continuation on the returned terminal.

When true, terminals returned by ghostty_snapshot_decoder_ready() and ghostty_snapshot_decoder_decode() use GHOSTTY_SNAPSHOT_DECODER_OPT_MAX_CONTINUATION_BYTES as their continuation tracking limit. The existing ghostty_terminal_continuation_* APIs can then export the exact unfinished VT or UTF-8 input restored from the snapshot.

This is false by default. A maximum continuation size of zero leaves tracking disabled. With a nonzero maximum, tracking remains enabled even when the decoded continuation is empty. Exporting an empty continuation does not disable it. Callers that do not need ongoing tracking must still set GHOSTTY_TERMINAL_OPT_CONTINUATION_MAX_BYTES to zero after export and before writing post-snapshot input.

Input type: bool *

const GhosttySnapshotDecoderOption(1)
GHOSTTY_SNAPSHOT_DECODER_OPT_MAX_VALUE → const GhosttySnapshotDecoderOption
const GhosttySnapshotDecoderOption(2147483647)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → int
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromValue(int value) → GhosttySnapshotDecoderOption

Constants

values → const List<GhosttySnapshotDecoderOption>
A constant List of the values in this enum, in order of their declaration.