Skip to main content

OutputSnapshot

Struct OutputSnapshot 

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

Snapshot of terminal output zones, excluding prompt input/history state.

Implementations§

Source§

impl OutputSnapshot

Source

pub fn block_count(&self) -> usize

Returns the number of blocks retained by this presentation model.

Source

pub fn suggestion_ids(&self) -> &[BlockId]

Returns the ordered block ids currently present in the suggestions zone.

Source

pub fn new_block( &mut self, debug_id: impl Into<String>, block: impl Into<StyledBlock>, ) -> BlockId

Allocates and stores a block in this output snapshot.

Source

pub fn set_block(&mut self, id: BlockId, block: impl Into<StyledBlock>)

Replaces one block in this output snapshot.

Source

pub fn remove_block(&mut self, id: BlockId)

Removes one block and all of its zone references.

Source

pub fn push_history(&mut self, id: BlockId)

Appends a block to snapshot history.

Source

pub fn push_above_active(&mut self, id: BlockId)

Appends a block to the snapshot active zone.

Source

pub fn push_above_active_before_any<I>(&mut self, id: BlockId, anchors: I)
where I: IntoIterator<Item = BlockId>,

Moves a block before the first matching snapshot active-zone anchor.

Source

pub fn push_above_sticky(&mut self, id: BlockId)

Appends a block to the snapshot sticky zone.

Source

pub fn remove_above_sticky(&mut self, id: BlockId)

Removes a block reference from the snapshot sticky zone.

Source

pub fn push_below(&mut self, id: BlockId)

Appends a block to the snapshot below-prompt zone.

Source

pub fn print_output( &mut self, debug_id: impl Into<String>, block: impl Into<StyledBlock>, ) -> BlockId

Creates and appends one snapshot history block.

Trait Implementations§

Source§

impl Clone for OutputSnapshot

Source§

fn clone(&self) -> OutputSnapshot

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 OutputSnapshot

Source§

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

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

impl Default for OutputSnapshot

Source§

fn default() -> OutputSnapshot

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

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<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> 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> 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 = !

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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