Struct typout::Typout

pub struct Typout { /* fields omitted */ }

Typout represents a wrapper around the standard output of the current process (stdout).

Implementations

impl Typout

pub fn with_spinner(spinner: Spinner) -> Self

Creates a new Typout object with a configured spinner instance.

impl Typout

pub fn set_spinner(&mut self, spinner: Spinner)

Sets the spinner instance.

pub fn write<D>(&mut self, data: D) where
    D: Into<String>, 

Appends data to the output buffer.

pub fn drain(&self)

Clears buffered output data.

pub fn flush(&self)

Sends buffered output data to the standard output of the current process which displays the data in the terminal. The output buffer is cleared afterwards.

pub fn print<D>(&mut self, data: D) where
    D: Into<String>, 

Appends data to the output buffer and calls the flush() method.

pub fn pin<I, D>(&self, id: I, data: D) where
    I: Into<String>,
    D: Into<String>, 

Creates a new pinned message or updates an existing one. Pinned messages always stayed visible at the end of the output stream. An arbitrary number of pinned messages is allowed. Pins are uniquely identified by the provided id parameter.

pub fn spin<I, D>(&mut self, id: I, data: D) where
    I: Into<String>,
    D: Into<String>, 

Creates a new animated pinned message or updates an existing one. It spawns the spinner animation thread for each new id. If the spinner with the provided id already exists, then only the message is updated.

pub fn unpin<I>(&mut self, id: I) where
    I: Into<String>, 

Removes a pinned message with the provided id. This method works for all pinned messages including animated spinners.

Trait Implementations

impl Clone for Typout

fn clone(&self) -> Typout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Typout

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

Formats the value using the given formatter.

impl Default for Typout

When the terminal starts, the output handler is spawned in a new thread. The messages and all other intents are sent the output through a channel.

fn default() -> Self

Returns the "default value" for a type.

impl Drop for Typout

For the application to gracefully exits, we make sure that all the messages are flushed and spawned threads exit before the object is dropped.

fn drop(&mut self)

Executes the destructor for this type.