Struct ProgramOptions

pub struct ProgramOptions {
    pub alt_screen: bool,
    pub mouse_mode: MouseMode,
    pub bracketed_paste: bool,
    pub focus_reporting: bool,
    pub fps: u16,
    pub headless: bool,
    pub install_signal_handler: bool,
    pub without_renderer: bool,
    pub output: Option<Box<dyn Write + Send + Sync>>,
    pub input: Option<Box<dyn Read + Send + Sync>>,
}

Options for configuring the program

Fields

alt_screen: bool

Whether to use alternate screen

mouse_mode: MouseMode

Mouse tracking mode

bracketed_paste: bool

Enable bracketed paste mode

focus_reporting: bool

Enable focus reporting

fps: u16

Frames per second (0 = unlimited)

headless: bool

Run in headless mode without rendering

install_signal_handler: bool

Disable signal handlers

without_renderer: bool

Disable renderer

output: Option<Box<dyn Write + Send + Sync>>

Custom output writer

input: Option<Box<dyn Read + Send + Sync>>

Custom input reader

Implementations

impl ProgramOptions

pub fn new() -> Self

Create new default options

pub fn with_alt_screen(self, enable: bool) -> Self

Enable or disable alternate screen

pub fn with_mouse_mode(self, mode: MouseMode) -> Self

Set mouse tracking mode

pub fn with_bracketed_paste(self, enable: bool) -> Self

Enable bracketed paste mode

pub fn with_focus_reporting(self, enable: bool) -> Self

Enable focus reporting

pub fn with_fps(self, fps: u16) -> Self

Set frames per second

pub fn headless(self) -> Self

Run in headless mode

pub fn without_signal_handler(self) -> Self

Disable signal handlers

pub fn without_renderer(self) -> Self

Disable renderer

pub fn with_output(self, output: Box<dyn Write + Send + Sync>) -> Self

Set custom output

pub fn with_input(self, input: Box<dyn Read + Send + Sync>) -> Self

Set custom input source

pub fn with_input_string(self, input: &str) -> Self

Set input from a string (convenience method for testing)

Trait Implementations

impl Default for ProgramOptions

fn default() -> Self

Returns the “default value” for a type.