Struct EngineOptions 

#[non_exhaustive]
pub struct EngineOptions { /* private fields */ }

Engine limits, with Ghostty’s defaults: 10,000,000 bytes of scrollback (scrollback-limit in ghostty +show-config --default), so a busy terminal holds as much history as Ghostty’s and no more.

Implementations

impl EngineOptions

pub fn with_scrollback_bytes(self, bytes: usize) -> Self

Set the scrollback byte limit.

pub fn with_scrollback_lines(self, lines: Option<usize>) -> Self

Set the scrollback line limit.

pub fn with_terminfo_name(self, name: impl Into<String>) -> Self

Set the terminfo name.

pub fn with_clipboard_write_max_bytes(self, bytes: usize) -> Self

Set the largest decoded Kitty clipboard write.

pub fn with_park(self, park: ParkOptions) -> Self

Set when an idle terminal parks and where its snapshot goes. On by default, after 60 seconds idle, in memory.

pub fn park(&self) -> &ParkOptions

When an idle terminal parks and where its snapshot goes.

pub fn scrollback_bytes(&self) -> usize

The scrollback byte limit. Zero disables scrollback.

pub fn scrollback_lines(&self) -> Option<usize>

The scrollback line limit; None is unlimited.

pub fn terminfo_name(&self) -> &str

The terminfo name reported to XTGETTCAP.

pub fn clipboard_write_max_bytes(&self) -> usize

The largest decoded Kitty clipboard write.

Trait Implementations

impl Clone for EngineOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineOptions

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

Formats the value using the given formatter.

impl Default for EngineOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for EngineOptions

impl PartialEq for EngineOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EngineOptions