Skip to main content

Console

Struct Console 

Source
pub struct Console { /* private fields */ }
Expand description

The console / shell component.

Implementations§

Source§

impl Console

Source

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

Source

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

Source

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

Source

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

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

Source

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

Source

pub fn line_count(&self) -> usize

Source

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 on the host’s thread and there is no internal async work — so it is always idle from the component’s own perspective.

Source

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

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

Source

pub fn plain_text(&self) -> String

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

Trait Implementations§

Source§

impl Clone for Console

Source§

fn clone(&self) -> Console

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 Debug for Console

Source§

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

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

impl<'de> Deserialize<'de> for Console

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Facet for Console

Source§

fn title(&self) -> &str

Source§

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

Source§

fn state_json(&self) -> Value

Source§

fn caps(&self) -> FacetCaps

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

fn scale(&self) -> f32

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

fn set_scale(&mut self, scale: f32)

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

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).
Source§

fn selection_json(&self) -> Value

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

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

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

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

Accept pasted text. Returns true if consumed.
Source§

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

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).
Source§

impl Serialize for Console

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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.