Struct Runtime 

pub struct Runtime<A, B = DefaultTerminal> { /* private fields */ }

A blocking full-screen application runtime.

Runtime::new uses the production executor, clock, and TUI session profile. With the crossterm feature it also supplies a production terminal backend: graphics-enabled Unix builds use the native bidirectional connection for capability queries, and other builds use Crossterm. A runtime-only build must provide one with backend. Builders replace those boundaries or individual session choices before run takes ownership and blocks the calling thread.

Implementations

impl<A> Runtime<A, DefaultTerminal>

pub fn new(application: A) -> Self

Builds a runtime with production defaults.

pub fn run(self) -> Result<A::Model, Error>

where A: Application,

Runs with the default production terminal backend.

A graphics-enabled Unix build uses the native bidirectional connection so protocol capabilities can be positively queried. Other builds use the portable Crossterm backend.

impl<A, B> Runtime<A, B>

pub fn backend<U>(self, backend: U) -> Runtime<A, U>

where U: TerminalBackend + Send + 'static,

Replaces the physical connection used for the session, input, and queries.

pub fn executor(self, executor: impl Executor) -> Self

Replaces the executor used by effects and subscriptions.

pub fn clock(self, clock: impl Clock) -> Self

Replaces the clock used by effects and frame scheduling.

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

Enables or disables raw input mode for the session.

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

Enables or disables the alternate screen for the session.

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

Enables or disables bracketed-paste reporting.

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

Enables or disables focus-change reporting.

pub const fn keyboard_enhancement( self, flags: Option<KeyboardEnhancementFlags>, ) -> Self

Selects the enhanced-keyboard information requested when supported.

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

Enables or disables mouse capture.

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

Hides the cursor until a frame places it or the session restores it.

impl<A, B> Runtime<A, B>

where A: Application, B: TerminalBackend + Send + 'static,

pub fn run(self) -> Result<A::Model, Error>

Drives the application on the calling thread and returns its final model.