Struct TerminalOptions 

pub struct TerminalOptions {
    pub caps: Option<TerminalCaps>,
    pub capture_stderr: bool,
    pub cursor_style: Option<CursorStyle>,
    pub mouse: bool,
    /* private fields */
}

Options controlling terminal entry.

Fields

caps: Option<TerminalCaps>

Capabilities resolved for the controlling terminal.

None asks Terminal::enter to negotiate capabilities while using the same decoder that the live input pump will own.

capture_stderr: bool

Whether fd 2 is captured while the terminal owns the viewport.

Capturing is enabled by default. Disable it when stderr already targets an application-managed sink that must remain live during the TUI session.

cursor_style: Option<CursorStyle>

Cursor shape to use while the application owns the terminal.

mouse: bool

Whether inline mouse reporting is enabled for the whole session.

Off by default so the terminal’s native text selection keeps working; the alternate screen always enables reporting while it is active.

Implementations

impl TerminalOptions

pub fn new(caps: TerminalCaps) -> Self

Creates options for already-resolved terminal capabilities.

Examples found in repository

examples/footers.rs (line 56)

async fn main() -> io::Result<()> {
	let caps = detect();
	let charset = UiContext::default().with_terminal_caps(&caps).charset;
	let mut terminal = Terminal::enter(TerminalOptions::new(caps).mouse(true))?;
	let mut renderer = Renderer::new(TtyOut::new()?);
	renderer.apply_caps(&caps)?;
	match run(&mut terminal, &mut renderer, charset).await {
		Ok(()) => terminal.leave_alt(),
		Err(error) => {
			let _ = terminal.leave_alt();
			Err(error)
		},
	}
}

examples/chat/main.rs (line 59)

async fn main() -> io::Result<()> {
	let caps = detect();
	// One detected presentation context — charset, graphics, appearance —
	// threads through every scene instead of per-module hardcodes.
	let ctx = UiContext::default().with_terminal_caps(&caps);
	let mut terminal =
		Terminal::enter(TerminalOptions::new(caps).cursor_style(CursorStyle::BlinkingBar))?;
	let mut renderer = Renderer::new(TtyOut::new()?);
	renderer.apply_caps(&caps)?;
	run(&mut terminal, &mut renderer, &ctx).await
}

pub fn probe_results(self, probe: ProbeResults) -> Self

Carries replies and preserved input from an earlier crate::negotiate call into terminal mode restoration and the live decoder.

pub const fn probe_timeout(self, timeout: Duration) -> Self

Sets the capability-probe deadline used when capabilities were not supplied.

pub const fn cursor_style(self, cursor_style: CursorStyle) -> Self

Requests a cursor style for the terminal session.

Examples found in repository

examples/chat/main.rs (line 59)

async fn main() -> io::Result<()> {
	let caps = detect();
	// One detected presentation context — charset, graphics, appearance —
	// threads through every scene instead of per-module hardcodes.
	let ctx = UiContext::default().with_terminal_caps(&caps);
	let mut terminal =
		Terminal::enter(TerminalOptions::new(caps).cursor_style(CursorStyle::BlinkingBar))?;
	let mut renderer = Renderer::new(TtyOut::new()?);
	renderer.apply_caps(&caps)?;
	run(&mut terminal, &mut renderer, &ctx).await
}

pub const fn mouse(self, mouse: bool) -> Self

Enables inline mouse reporting (click, drag, motion) for the session.

This trades native text selection for pointer interaction, so leave it off unless the application is genuinely pointer-driven.

Examples found in repository

examples/footers.rs (line 56)

async fn main() -> io::Result<()> {
	let caps = detect();
	let charset = UiContext::default().with_terminal_caps(&caps).charset;
	let mut terminal = Terminal::enter(TerminalOptions::new(caps).mouse(true))?;
	let mut renderer = Renderer::new(TtyOut::new()?);
	renderer.apply_caps(&caps)?;
	match run(&mut terminal, &mut renderer, charset).await {
		Ok(()) => terminal.leave_alt(),
		Err(error) => {
			let _ = terminal.leave_alt();
			Err(error)
		},
	}
}

pub const fn capture_stderr(self, capture: bool) -> Self

Enables or disables capture of unmanaged stderr writes.

Trait Implementations

impl Clone for TerminalOptions

fn clone(&self) -> TerminalOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalOptions

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

Formats the value using the given formatter.

impl Default for TerminalOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TerminalOptions

impl PartialEq for TerminalOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TerminalOptions