Struct TerminalSelectionFormatOptions 

#[repr(C)]
pub struct TerminalSelectionFormatOptions {
    pub size: usize,
    pub emit: Type,
    pub unwrap: bool,
    pub trim: bool,
    pub selection: *const Selection,
}

Options for one-shot formatting of a terminal selection.

This is a sized struct. Use GHOSTTY_INIT_SIZED() to initialize it.

If selection is NULL, the terminal’s current active selection is used. If selection is non-NULL, that caller-provided snapshot selection is used.

The selection is formatted from the terminal’s active screen using the same formatting semantics as GhosttyFormatter. For copy/clipboard behavior matching Ghostty’s Screen.selectionString(), use plain output with unwrap and trim both set to true.

Fields

size: usize

Size of this struct in bytes. Must be set to sizeof(GhosttyTerminalSelectionFormatOptions).

emit: Type

Output format to emit.

unwrap: bool

Whether to unwrap soft-wrapped lines.

trim: bool

Whether to trim trailing whitespace on non-blank lines.

selection: *const Selection

Optional selection to format.

If NULL, the terminal’s current active selection is used. If the terminal has no active selection, formatting returns GHOSTTY_NO_VALUE.

If non-NULL, the pointed-to selection must be a valid snapshot selection for this terminal and must obey GhosttySelection lifetime rules.

Trait Implementations

impl Clone for TerminalSelectionFormatOptions

fn clone(&self) -> TerminalSelectionFormatOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TerminalSelectionFormatOptions

impl Debug for TerminalSelectionFormatOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TerminalSelectionFormatOptions

fn default() -> Self

Returns the “default value” for a type.