Skip to main content

RuntimeOptions

Struct RuntimeOptions 

Source
pub struct RuntimeOptions {
    pub cursor_style: CursorStyle,
    pub cursor_blink: bool,
    pub scrollback_lines: u32,
    pub tab_width: u8,
    pub convert_eol: bool,
    pub screen_reader_mode: bool,
    pub bracketed_paste: bool,
    pub minimum_contrast_ratio_x100: u16,
    pub renderer: RendererType,
    pub theme: ThemePalette,
}
Expand description

The complete, validated runtime option state.

Construct with RuntimeOptions::default (safe defaults) and mutate via RuntimeOptions::apply_patch. Direct field assignment is allowed for host-side initialisation but bypasses validation — prefer the patch API for any host-driven mutation.

Fields§

§cursor_style: CursorStyle

Cursor presentation style.

§cursor_blink: bool

Whether the cursor blinks.

§scrollback_lines: u32

Scrollback retention in lines (0 = no scrollback).

§tab_width: u8

Tab stop width in columns (1..=16).

§convert_eol: bool

Whether bare LF is treated as CRLF on output (convertEol).

§screen_reader_mode: bool

Whether screen-reader assistive output mode is active.

§bracketed_paste: bool

Whether bracketed paste is enabled.

§minimum_contrast_ratio_x100: u16

Minimum enforced foreground/background contrast ratio, ×100 (100..=2100). 100 (1.0:1) disables enforcement.

§renderer: RendererType

Active rendering backend.

§theme: ThemePalette

Theme palette.

Implementations§

Source§

impl RuntimeOptions

Source

pub fn apply_patch( &mut self, patch: &RuntimeOptionPatch, caps: &OptionCapabilityProfile, correlation_id: &str, ) -> RuntimeOptionUpdate

Apply a (sparse) patch atomically against the given capability profile.

Returns a RuntimeOptionUpdate describing the outcome. On any validation or gating failure the update is rejected, every offending field’s error is reported, and self is left unchanged. On success the patch is committed atomically and the changed fields plus required renderer/engine synchronisation are reported.

correlation_id is recorded for structured-log triage only; it does not affect the decision.

Source

pub fn validate( &self, caps: &OptionCapabilityProfile, ) -> Vec<RuntimeOptionError>

Validate this option state against a capability profile, returning every violation. An empty vector means fully valid and supported.

Source

pub fn web_dataset(&self) -> [(&'static str, String); 3]

Stable, ordered CSS data-attribute pairs for the browser host. Mirrors the accessibility surface’s web_dataset() convention so generated DOM markup is byte-for-byte reproducible.

Source

pub fn to_jsonl(&self, correlation_id: &str) -> String

Serialise the full option snapshot to a single deterministic JSON line.

Trait Implementations§

Source§

impl Clone for RuntimeOptions

Source§

fn clone(&self) -> RuntimeOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RuntimeOptions

Source§

impl Debug for RuntimeOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RuntimeOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for RuntimeOptions

Source§

impl PartialEq for RuntimeOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RuntimeOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more