Skip to main content

Cmd

Enum Cmd 

Source
pub enum Cmd<M> {
Show 14 variants None, Quit, Batch(Vec<Cmd<M>>), Sequence(Vec<Cmd<M>>), Msg(M), Tick(Duration), Log { text: String, mode: SanitizeMode, }, Task(TaskSpec, Box<dyn FnOnce() -> M + Send>), SaveState, RestoreState, SetMouseCapture(bool), SetClipboard(String), GetClipboard, SetTickStrategy(Box<dyn TickStrategy>),
}
Expand description

Commands represent side effects to be executed by the runtime.

Commands are returned from init() and update() to trigger actions like quitting, sending messages, or scheduling ticks.

Variants§

§

None

No operation.

§

Quit

Quit the application.

§

Batch(Vec<Cmd<M>>)

Execute multiple commands as a batch (currently sequential).

§

Sequence(Vec<Cmd<M>>)

Execute commands sequentially.

§

Msg(M)

Send a message to the model.

§

Tick(Duration)

Schedule a tick after a duration.

§

Log

Write a log message to the terminal output.

This writes to the scrollback region in inline mode, or is ignored/handled appropriately in alternate screen mode. The policy is applied at the output boundary. Prefer Cmd::log or Cmd::log_sgr_only; raw output is an explicit opt-in that can corrupt terminal state.

Fields

§text: String
§

Task(TaskSpec, Box<dyn FnOnce() -> M + Send>)

Execute a blocking operation on a background thread.

When effect queue scheduling is enabled, tasks are enqueued and executed in Smith-rule order on a dedicated worker thread. Otherwise the closure runs on a spawned thread immediately. The return value is sent back as a message to the model.

§

SaveState

Save widget state to the persistence registry.

Triggers a flush of the state registry to the storage backend. No-op if persistence is not configured.

§

RestoreState

Restore widget state from the persistence registry.

Triggers a load from the storage backend and updates the cache. No-op if persistence is not configured. Returns a message via callback if state was successfully restored.

§

SetMouseCapture(bool)

Toggle mouse capture at runtime.

Instructs the terminal session to enable or disable mouse event capture. No-op in test simulators.

§

SetClipboard(String)

Copy text using OSC 52 on supported terminals.

§

GetClipboard

Request clipboard text asynchronously as an Event::Clipboard reply. Unsupported terminals may ignore the request; no reply is guaranteed.

§

SetTickStrategy(Box<dyn TickStrategy>)

Replace the tick strategy at runtime.

Takes ownership of a boxed strategy. Use when switching from one strategy to another (e.g., Uniform → Predictive after loading persisted transition data).

Implementations§

Source§

impl<M> Cmd<M>

Source

pub fn none() -> Self

Create a no-op command.

Source

pub fn quit() -> Self

Create a quit command.

Source

pub fn msg(m: M) -> Self

Create a message command.

Source

pub fn log(msg: impl Into<String>) -> Self

Create a log command.

The message will be sanitized and written to the terminal log (scrollback). A newline is appended if not present.

Source

pub fn log_sgr_only(msg: impl Into<String>) -> Self

Log colored text while filtering cursor, clipboard and terminal controls.

The native writer permits only bounded SGR styling and resets styles at each line/write. As with Self::log, native output normalizes newlines to CRLF and appends a final newline; overlay mode displays only the first width-clamped line. Capturing hosts retain logical text without adding terminal newlines or reset sequences.

Source

pub fn log_raw(msg: impl Into<String>) -> Self

Log trusted text, including arbitrary terminal commands.

The caller asserts the contents are trusted. Cursor movement, mode changes and clearing can corrupt inline chrome. Prefer Self::log_sgr_only for compiler/test output. This is a logical log message: native CRLF normalization and final-newline insertion still apply, so this is not a byte-transparent transport.

Source

pub fn log_text(text: Text<'_>) -> Self

Log annotated text using its explicit output policy.

The output boundary reapplies the policy even when the marker was constructed directly. See Self::log_raw for trusted-text behavior.

Source

pub fn batch(cmds: Vec<Self>) -> Self

Create a batch of commands.

Source

pub fn sequence(cmds: Vec<Self>) -> Self

Create a sequence of commands.

Source

pub fn type_name(&self) -> &'static str

Return a stable name for telemetry and tracing.

Source

pub fn tick(duration: Duration) -> Self

Create a tick command.

Source

pub fn task<F>(f: F) -> Self
where F: FnOnce() -> M + Send + 'static,

Create a background task command.

The closure runs on a spawned thread (or the effect queue worker when scheduling is enabled). When it completes, the returned message is sent back to the model’s update().

Source

pub fn task_with_spec<F>(spec: TaskSpec, f: F) -> Self
where F: FnOnce() -> M + Send + 'static,

Create a background task command with explicit scheduling metadata.

Source

pub fn task_weighted<F>(weight: f64, estimate_ms: f64, f: F) -> Self
where F: FnOnce() -> M + Send + 'static,

Create a background task command with explicit weight and estimate.

Source

pub fn task_named<F>(name: impl Into<String>, f: F) -> Self
where F: FnOnce() -> M + Send + 'static,

Create a named background task command.

Source

pub fn set_tick_strategy(strategy: impl TickStrategy + 'static) -> Self

Replace the active tick strategy at runtime.

Use when switching strategies (e.g., Uniform → Predictive after loading persisted transition data).

Source

pub fn save_state() -> Self

Create a save state command.

Triggers a flush of the state registry to the storage backend. No-op if persistence is not configured.

Source

pub fn restore_state() -> Self

Create a restore state command.

Triggers a load from the storage backend. No-op if persistence is not configured.

Source

pub fn set_mouse_capture(enabled: bool) -> Self

Create a mouse capture toggle command.

Instructs the runtime to enable or disable mouse event capture on the underlying terminal session.

Source

pub fn set_clipboard(text: impl Into<String>) -> Self

Copy text to the system clipboard through the runtime’s output owner.

Source

pub fn get_clipboard() -> Self

Request clipboard text. Handle Event::Clipboard for the reply.

Source

pub fn count(&self) -> usize

Count the number of atomic commands in this command.

Returns 0 for None, 1 for atomic commands, and recursively counts for Batch/Sequence.

Trait Implementations§

Source§

impl<M: Debug> Debug for Cmd<M>

Source§

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

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

impl<M> Default for Cmd<M>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<M> !RefUnwindSafe for Cmd<M>

§

impl<M> !Sync for Cmd<M>

§

impl<M> !UnwindSafe for Cmd<M>

§

impl<M> Forget for Cmd<M>

§

impl<M> Freeze for Cmd<M>
where Vec<Cmd<M>>: Freeze, M: Freeze, Box<dyn FnOnce() -> M + Send>: Freeze,

§

impl<M> Move for Cmd<M>

§

impl<M> Send for Cmd<M>
where M: Send, Vec<Cmd<M>>: Send, Box<dyn FnOnce() -> M + Send>: Send,

§

impl<M> Unpin for Cmd<M>
where M: Unpin, Vec<Cmd<M>>: Unpin, Box<dyn FnOnce() -> M + Send>: Unpin,

§

impl<M> UnsafeUnpin for Cmd<M>
where Vec<Cmd<M>>: UnsafeUnpin, M: UnsafeUnpin, Box<dyn FnOnce() -> M + Send>: UnsafeUnpin,

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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