Struct Console 

pub struct Console { /* private fields */ }

The console / shell component.

Implementations

impl Console

pub fn new(title: impl Into<String>) -> Self

pub fn with_prompt(self, p: impl Into<String>) -> Self

pub fn with_cursor(self, c: Cursor) -> Self

pub fn with_max_lines(self, n: usize) -> Self

Cap the scrollback ring (oldest lines dropped past this).

pub fn state(&self) -> &ConsoleModel

FC-3 — read the complete observable state at any frame boundary.

pub fn update(&mut self, msg: Msg) -> Vec<Effect>

FC-2 / FC-8 — the single mutation path. Apply one Msg; return the Effects the host should run (empty unless a command was submitted). Every gesture and every host push routes here, so live == headless.

pub fn push_line(&mut self, raw: impl AsRef<str>)

Append a raw line (ANSI-parsed), dropping the oldest past max_lines.

pub fn set_input(&mut self, s: impl Into<String>)

Replace the in-progress input line.

pub fn select(&mut self, id: Option<LineId>)

Select a scrollback line by stable id (or clear). A thin wrapper over the FC-2 mutation path.

pub fn advance(&mut self, dt: f32)

Advance the scrollback animation (the injected clock; deterministic).

pub fn line_count(&self) -> usize

pub fn is_idle(&self) -> bool

Whether the console is idle (FC-8). The console is host-pushed and synchronous — lines arrive via push_line and there is no internal async work — so it is always idle from the component’s own perspective. (A submitted command’s execution is the host’s RunCommand effect, not the console’s own work.)

pub fn plain_text(&self) -> String

The plain-text scrollback (for copy/search).

impl Console

pub fn view(&self, ui: &mut Ui) -> Vec<Msg>

FC-9 render — a pure function of &self: it paints the scrollback + the prompt/cursor and returns the Msgs the gestures produced (typing, backspace, submit, history, scroll, per-line select). It MUST NOT mutate the ConsoleModel; the impl_facet_via_elm! bridge applies the returned messages through update.

The only &self-external effects are egui-side, not model writes: it may request_focus/request_repaint. The layout-derived scroll extent is returned as a Msg::SetScrollMax (applied next frame) rather than written here — that is the deliberate one-frame trail noted on the crate.

Trait Implementations

impl Clone for Console

fn clone(&self) -> Console

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CopySource for Console

fn copy_kinds(&self) -> &[ClipKind]

The kinds this source can offer, richest first.

fn copy_payload(&self) -> Option<ClipPayload>

Produce the payload for the current selection (richest representation).

impl Debug for Console

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

Formats the value using the given formatter.

impl Elm for Console

type Model = ConsoleModel

All observable state, in one serializable struct (FC-1 / FC-3).

type Msg = Msg

Every input the component accepts (FC-2). The only legal way to mutate the Model.

type Effect = Effect

Side work as data (FC-8). Use enum Effect {} when the component does no I/O.

fn title(&self) -> &str

The deck keys facets off this (mirrors Facet::title).

fn state(&self) -> &ConsoleModel

FC-3 — read the complete observable state at any frame boundary.

fn update(&mut self, msg: Msg) -> Vec<Effect>

FC-2 / FC-8 — the single mutation path. Apply one Msg; return the Effects the host should run (empty = nothing to do).

fn view(&self, ui: &mut Ui) -> Vec<Msg>

FC-9 / FC-4 — a pure function of &self: it paints and returns the Msgs it produced. It MUST NOT mutate the model or do I/O; the Facet::ui bridge applies the returned messages through update.

impl Facet for Console

fn ui(&mut self, ui: &mut Ui)

FC-9: the view is pure (paints + emits Msgs); FC-2: mutation only via update. The immediate-mode trait just bridges the two.

fn title(&self) -> &str

fn state_json(&self) -> Value

fn selection_json(&self) -> Value

The current selection as JSON (also folded into state_json by convention). Null when nothing/none selectable.

fn caps(&self) -> FacetCaps

What this facet can do. Override to opt into capabilities.

fn scale(&self) -> f32

Current uniform scale (1.0 = native). Override if caps().scalable.

fn set_scale(&mut self, scale: f32)

Set the uniform scale; clamp internally. Default no-op (not scalable).

fn copy(&mut self) -> Option<String>

Clipboard hooks — see clipboard.rs. Defaults: nothing to give/take. Returns the text to place on the clipboard (None = nothing copyable now).

fn paste(&mut self, text: &str) -> bool

Accept pasted text. Returns true if consumed.

fn as_any_mut(&mut self) -> Option<&mut dyn Any>

Optional downcast handle for hosts that need typed access to a specific facet living inside a FacetDeck (e.g. a robot-UI driver clicking an app-level control that must forward to a concrete component’s own API). Defaulted to None so no existing facet has to change; a component opts in by returning Some(self).

fn cut(&mut self) -> Option<String>

Like copy, but also removes the selection. Default delegates to copy.

fn kind(&self) -> &'static str

Stable component-type id (e.g. "jobview", "graphpan", "table"). Two instances with the same kind can exchange portable state; the empty default "" means opted out of cross-instance clone.

fn portable_state(&self) -> Option<Value>

The portable subset of this facet’s state — the fields a same-kind sibling can adopt. None = not cloneable. Kept SEPARATE from state_json (the introspection dump, which may carry derived / render-only data) so this stays round-trippable through load_state.

fn load_state(&mut self, _state: &Value) -> bool

Adopt a portable state produced by portable_state on a same-kind sibling. Returns true if accepted. Default false (opt-in per component).

impl PasteTarget for Console

fn accepts(&self, k: ClipKind) -> bool

Does this target accept kind k?

fn paste_payload(&mut self, p: &ClipPayload)

Apply the payload. Text is the universal fallback (CLIP-3).