Struct Screen

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

A static snapshot of a terminal screen.

Implementations§

Source§

impl Screen

Source

pub fn to_svg<'s, 'f>( &'s self, fonts: &'f [&'f str], font_metrics: FontMetrics, ) -> impl Display + 's
where 'f: 's,

Get a std::fmt::Display that prints an SVG when formatted. Set fonts to specify fonts to be included in the SVG’s font-family style. font-family always includes monospace.

The SVG is generated once std::fmt::Display::fmt is called; cache the call’s output if you want to use it multiple times.

Source

pub fn lines(&self) -> u16

The number of screen lines in this snapshot.

Source

pub fn columns(&self) -> u16

The number of screen columns in this snapshot.

Source

pub fn cells(&self) -> impl Iterator<Item = &Cell>

An iterator over all cells in the terminal grid. This iterates over all columns in the first line from left to right, then the second line, etc.

Source

pub fn get(&self, line: u16, column: u16) -> Option<&Cell>

Get the cell at the terminal grid position specified by line and column.

Auto Trait Implementations§

§

impl Freeze for Screen

§

impl RefUnwindSafe for Screen

§

impl Send for Screen

§

impl Sync for Screen

§

impl Unpin for Screen

§

impl UnwindSafe for Screen

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> 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, 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