Struct anstyle_wincon::Console

source ·
pub struct Console<S>where
    S: WinconStream + Write,{ /* private fields */ }
Expand description

Write colored text to the screen

Implementations§

source§

impl<S> Console<S>where S: WinconStream + Write,

source

pub fn new(stream: S) -> Result<Self, S>

source

pub fn write( &mut self, fg: Option<AnsiColor>, bg: Option<AnsiColor>, data: &[u8] ) -> Result<usize>

Write colored text to the screen

source

pub fn flush(&mut self) -> Result<()>

source

pub fn reset(&mut self) -> Result<()>

Change the terminal back to the initial colors

source

pub fn close(self) -> Result<()>

Close the stream, reporting any errors

source

pub fn map<S1: WinconStream + Write>( self, op: impl FnOnce(S) -> S1 ) -> Console<S1>

Allow changing the stream

source

pub fn into_inner(self) -> S

Get the inner writer

source§

impl<S> Console<S>where S: WinconStream + Write + Lockable, <S as Lockable>::Locked: WinconStream + Write,

source

pub fn lock(self) -> <Self as Lockable>::Locked

Get exclusive access to the Console

Why?

  • Faster performance when writing in a loop
  • Avoid other threads interleaving output with the current thread

Trait Implementations§

source§

impl<S> Debug for Console<S>where S: WinconStream + Write + Debug,

source§

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

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

impl<S> Drop for Console<S>where S: WinconStream + Write,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<S> Lockable for Console<S>where S: WinconStream + Write + Lockable, <S as Lockable>::Locked: WinconStream + Write,

§

type Locked = Console<<S as Lockable>::Locked>

source§

fn lock(self) -> Self::Locked

Get exclusive access to the Stream Read more

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for Console<S>where S: RefUnwindSafe,

§

impl<S> Send for Console<S>where S: Send,

§

impl<S> Sync for Console<S>where S: Sync,

§

impl<S> Unpin for Console<S>where S: Unpin,

§

impl<S> UnwindSafe for Console<S>where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.