Struct RunConfig 

#[non_exhaustive]
pub struct RunConfig {
    pub mouse: bool,
}

Available on crate feature tui only.

Runtime configuration for run_with. Default matches run’s current behaviour, so run_with(app, RunConfig::default()) and run(app) behave identically.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mouse: bool

Whether to negotiate mouse reporting with the terminal (EnableMouseCapture/DisableMouseCapture).

Defaults to true. Set to false for no-mouse mode: a host where mouse capture is refused or unavailable (e.g. some multiplexers, restrictive SSH sessions, a screen reader driving the terminal) never gets the capture escape sequences at all — instead of getting them and then discarding whatever the terminal sends back. An app can read the live answer via crate::tui::backend::TuiBackend::mouse_enabled (kept separate from crate::backend::BackendCaps::mouse, which stays a static per-backend-type fact — see that accessor’s doc). Every Tier-1 gesture in this crate’s own examples has a key path that works with this flag off — see tests/conformance/scenarios/**/*_keyboard.scn.json — so turning it off costs an app nothing that a conformant AppLogic needs.

Implementations

impl RunConfig

pub fn no_mouse() -> Self

Convenience constructor for no-mouse mode: equivalent to RunConfig { mouse: false, ..Default::default() }.

RunConfig is #[non_exhaustive] so future fields can be added without breaking downstream callers — but that same attribute means a struct-literal expression (even one using ..Default::default()) is rejected by rustc (E0639) from outside this crate. Without this constructor, no consumer could actually build a non-default RunConfig at all: the field is pub, but the type would be write-only from any caller that isn’t quadraui itself. This method is the one supported way in.

Trait Implementations

impl Clone for RunConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RunConfig

impl Debug for RunConfig

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

Formats the value using the given formatter.

impl Default for RunConfig

fn default() -> Self

Returns the “default value” for a type.