GhosttySnapshotDecoderData enum

Queryable snapshot decoder data.

Each variant documents the output pointer type expected by ghostty_snapshot_decoder_get().

Inheritance
Available extensions

Values

GHOSTTY_SNAPSHOT_DECODER_DATA_INVALID → const GhosttySnapshotDecoderData

Invalid data type. Never results in data extraction.

const GhosttySnapshotDecoderData(0)
GHOSTTY_SNAPSHOT_DECODER_DATA_MAX_CONTINUATION_BYTES → const GhosttySnapshotDecoderData

Current maximum accepted continuation size.

This value is available in every non-failed decoder state.

Output type: size_t *

const GhosttySnapshotDecoderData(1)
GHOSTTY_SNAPSHOT_DECODER_DATA_SOURCE_OFFSET → const GhosttySnapshotDecoderData

Number of snapshot source bytes consumed so far.

At FINISH this identifies the first byte after the snapshot. Trailing bytes are not consumed. This value is unavailable after a decoding error, because the decoder can no longer guarantee its source position.

Output type: size_t *

const GhosttySnapshotDecoderData(2)
GHOSTTY_SNAPSHOT_DECODER_DATA_HISTORY_ROWS_PRIMARY → const GhosttySnapshotDecoderData

Advisory complete logical history extent for the primary screen.

The value counts rows before the active area, including any resident overlap carried before READY. It becomes available after READY validates.

Output type: uint64_t *

const GhosttySnapshotDecoderData(3)
GHOSTTY_SNAPSHOT_DECODER_DATA_HISTORY_ROWS_ALTERNATE → const GhosttySnapshotDecoderData

Advisory complete logical history extent for the alternate screen.

The value has the same semantics and lifetime as GHOSTTY_SNAPSHOT_DECODER_DATA_HISTORY_ROWS_PRIMARY. Querying it returns GHOSTTY_NO_VALUE when the snapshot does not declare an alternate screen.

Output type: uint64_t *

const GhosttySnapshotDecoderData(4)
GHOSTTY_SNAPSHOT_DECODER_DATA_PROGRESS_SCREEN → const GhosttySnapshotDecoderData

Screen associated with the most recently decoded history page.

This value is available only after ghostty_snapshot_decoder_next() returns GHOSTTY_SUCCESS. A later call to next replaces it or clears it when FINISH is reached or an error occurs.

Output type: GhosttyTerminalScreen *

const GhosttySnapshotDecoderData(5)
GHOSTTY_SNAPSHOT_DECODER_DATA_PROGRESS_ROWS → const GhosttySnapshotDecoderData

Rows prepended by the most recently decoded history page.

Zero means the page was consumed and validated but could not be applied to the live terminal.

Output type: size_t *

const GhosttySnapshotDecoderData(6)
GHOSTTY_SNAPSHOT_DECODER_DATA_PROGRESS_REMAINING → const GhosttySnapshotDecoderData

Page records remaining in the same screen's HISTORY sequence.

This is not a count of all pages remaining in the snapshot.

Output type: uint32_t *

const GhosttySnapshotDecoderData(7)
GHOSTTY_SNAPSHOT_DECODER_DATA_RETAIN_CONTINUATION → const GhosttySnapshotDecoderData

Whether decoded continuation tracking is retained on returned terminals.

This value is available in every non-failed decoder state.

Output type: bool *

const GhosttySnapshotDecoderData(8)
GHOSTTY_SNAPSHOT_DECODER_DATA_MAX_VALUE → const GhosttySnapshotDecoderData
const GhosttySnapshotDecoderData(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) → GhosttySnapshotDecoderData

Constants

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