Struct ProgramConfig

pub struct ProgramConfig {

    pub alt_screen: bool,
    pub mouse_motion: MouseMotion,
    pub report_focus: bool,
    pub fps: u32,
    pub without_renderer: bool,
    pub catch_panics: bool,
    pub signal_handler: bool,
    pub bracketed_paste: bool,
    pub output_writer: Option<Arc<Mutex<dyn AsyncWrite + Send + Unpin>>>,
    pub cancellation_token: Option<CancellationToken>,
    pub input_source: Option<InputSource>,
    pub event_channel_buffer: Option<usize>,
    pub memory_monitoring: bool,
    pub environment: Option<HashMap<String, String>>,
}

Configuration options for a Program.

This struct holds various settings that control the behavior of the Program, such as terminal features, rendering options, and panic/signal handling.

Fields

alt_screen: bool

Whether to use the alternate screen buffer.

mouse_motion: MouseMotion

The mouse motion reporting mode.

report_focus: bool

Whether to report focus events.

fps: u32

The target frames per second for rendering.

without_renderer: bool

Whether to disable the renderer entirely.

catch_panics: bool

Whether to catch panics and convert them into ProgramPanic errors.

signal_handler: bool

Whether to enable signal handling (e.g., Ctrl+C).

bracketed_paste: bool

Whether to enable bracketed paste mode.

output_writer: Option<Arc<Mutex<dyn AsyncWrite + Send + Unpin>>>

Optional custom output writer.

cancellation_token: Option<CancellationToken>

Optional cancellation token for external control.

input_source: Option<InputSource>

Optional custom input source.

event_channel_buffer: Option<usize>

The buffer size for the event channel (None for unbounded, Some(size) for bounded).

memory_monitoring: bool

Whether to enable memory usage monitoring.

environment: Option<HashMap<String, String>>

Optional environment variables to apply to external process commands.

Trait Implementations

impl Debug for ProgramConfig

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

Formats the value using the given formatter.

impl Default for ProgramConfig

fn default() -> Self

Returns the default ProgramConfig.

By default, the program does not use the alternate screen, has no mouse motion reporting, does not report focus, targets 60 FPS, enables rendering, catches panics, handles signals, and disables bracketed paste.