Skip to main content

Stage

katui_rt::session

Struct Stage 

Source 
pub struct Stage<W: Write> { /* private fields */ }
Expand description

The main-screen stage: hides the cursor on enter and restores the terminal on Stage::leave or drop. Unlike Session it never switches to the alternate screen: a run draws beside it, through Stage::writer, on the same stdout.

Implementations§

Source§

impl<W: Write> Stage<W>

Source

pub fn enter(out: W, teardown: Teardown) -> Result<Self, RtError>

Hide the cursor and hold out for the run.

Source

pub fn writer(&mut self) -> &mut W

The writer the run draws through.

Source

pub fn leave(self) -> Result<W>

Restore the terminal and return the writer.

Trait Implementations§

Source§

impl<W: Write> Drop for Stage<W>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<W> Forget for Stage<W>

§

impl<W> Freeze for Stage<W>
where Option<W>: Freeze,

§

impl<W> Move for Stage<W>

§

impl<W> RefUnwindSafe for Stage<W>
where Option<W>: RefUnwindSafe,

§

impl<W> Send for Stage<W>
where Option<W>: Send,

§

impl<W> Sync for Stage<W>
where Option<W>: Sync,

§

impl<W> Unpin for Stage<W>
where Option<W>: Unpin,

§

impl<W> UnsafeUnpin for Stage<W>
where Option<W>: UnsafeUnpin,

§

impl<W> UnwindSafe for Stage<W>
where Option<W>: UnwindSafe,

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

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.