Struct rhit::io::Sink1.0.0[−][src]

pub struct Sink { /* fields omitted */ }

A writer which will move data into the void.

This struct is generally created by calling sink. Please see the documentation of sink() for more details.

Trait Implementations

`impl Debug for Sink`1.16.0[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl<'_> Write for &'_ Sink`1.48.0[src]

`pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>`[src]

`pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>`[src]

`pub fn is_write_vectored(&self) -> bool`[src]

`pub fn flush(&mut self) -> Result<(), Error>`[src]

`pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`[src]

`pub fn write_all_vectored( &mut self, bufs: &mut [IoSlice<'_>] ) -> Result<(), Error>`[src]

`pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>`[src]

`pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`[src]

`impl Write for Sink`[src]

`pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>`[src]

`pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>`[src]

`pub fn is_write_vectored(&self) -> bool`[src]

`pub fn flush(&mut self) -> Result<(), Error>`[src]

`pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`[src]

`pub fn write_all_vectored( &mut self, bufs: &mut [IoSlice<'_>] ) -> Result<(), Error>`[src]

`pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>`[src]

`pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Sink`[src]

`impl Send for Sink`[src]

`impl Sync for Sink`[src]

`impl Unpin for Sink`[src]

`impl UnwindSafe for Sink`[src]

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`[src]

`impl<T, A> ExecutableCommand<A> for T where T: Write, A: Display,` [src]

`pub fn execute( &mut self, command: impl Command<AnsiType = A> ) -> Result<&mut T, ErrorKind>`[src]

Executes the given command directly.

The given command its ANSI escape code will be written and flushed onto Self.

Arguments

Command

The command that you want to execute directly.

Example

use std::io::{Write, stdout};
use crossterm::{Result, ExecutableCommand, style::Print};

 fn main() -> Result<()> {
     // will be executed directly
      stdout()
        .execute(Print("sum:\n".to_string()))?
        .execute(Print(format!("1 + 1= {} ", 1 + 1)))?;

      Ok(())

     // ==== Output ====
     // sum:
     // 1 + 1 = 2
 }

Have a look over at the Command API for more details.

Notes

In the case of UNIX and Windows 10, ANSI codes are written to the given 'writer'.
In case of Windows versions lower than 10, a direct WinApi call will be made. The reason for this is that Windows versions lower than 10 do not support ANSI codes, and can therefore not be written to the given writer. Therefore, there is no difference between execute and queue for those old Windows versions.

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Fun for T`[src]

`pub fn fun<F, D>(self, f: F) -> T where F: FnMut(&T) -> D,` [src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Pointable for T`

`pub const ALIGN: usize`

`type Init = T`

The type for initializers.

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`

`pub unsafe fn deref<'a>(ptr: usize) -> &'a TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`

`pub unsafe fn drop(ptr: usize)`

`impl<T, A> QueueableCommand<A> for T where T: Write, A: Display,` [src]

`pub fn queue( &mut self, command: impl Command<AnsiType = A> ) -> Result<&mut T, ErrorKind>`[src]

Queues the given command for further execution.

Queued commands will be executed in the following cases:

When flush is called manually on the given type implementing io::Write.
The terminal will flush automatically if the buffer is full.
Each line is flushed in case of stdout, because it is line buffered.

Arguments

Command

The command that you want to queue for later execution.

Examples

use std::io::{Write, stdout};
use crossterm::{Result, QueueableCommand, style::Print};

 fn main() -> Result<()> {
    let mut stdout = stdout();

    // `Print` will executed executed when `flush` is called.
    stdout
        .queue(Print("foo 1\n".to_string()))?
        .queue(Print("foo 2".to_string()))?;

    // some other code (no execution happening here) ...

    // when calling `flush` on `stdout`, all commands will be written to the stdout and therefore executed.
    stdout.flush()?;

    Ok(())

    // ==== Output ====
    // foo 1
    // foo 2
}

Have a look over at the Command API for more details.

Notes

In the case of UNIX and Windows 10, ANSI codes are written to the given 'writer'.
In case of Windows versions lower than 10, a direct WinApi call will be made. The reason for this is that Windows versions lower than 10 do not support ANSI codes, and can therefore not be written to the given writer. Therefore, there is no difference between execute and queue for those old Windows versions.

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct rhit::io::Sink1.0.0[−][src]

Trait Implementations

impl Debug for Sink1.16.0[src]

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

impl<'_> Write for &'_ Sink1.48.0[src]

pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>[src]

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>[src]

pub fn is_write_vectored(&self) -> bool[src]

pub fn flush(&mut self) -> Result<(), Error>[src]

pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[src]

pub fn write_all_vectored( &mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>[src]

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>[src]

pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut Rimpl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;[src]

Notable traits for &'_ mut R

impl Write for Sink[src]

pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>[src]

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>[src]

pub fn is_write_vectored(&self) -> bool[src]

pub fn flush(&mut self) -> Result<(), Error>[src]

pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[src]

pub fn write_all_vectored( &mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>[src]

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>[src]

pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut Rimpl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;[src]

Notable traits for &'_ mut R

Auto Trait Implementations

impl RefUnwindSafe for Sink[src]

impl Send for Sink[src]

impl Sync for Sink[src]

impl Unpin for Sink[src]

impl UnwindSafe for Sink[src]

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut Rimpl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;[src]

Notable traits for &'_ mut R

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut Rimpl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;[src]

Notable traits for &'_ mut R

impl<T, A> ExecutableCommand<A> for T where T: Write, A: Display, [src]

pub fn execute( &mut self, command: impl Command<AnsiType = A>) -> Result<&mut T, ErrorKind>[src]

Arguments

Example

Notes

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T> Fun for T[src]

pub fn fun<F, D>(self, f: F) -> T where F: FnMut(&T) -> D, [src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a TⓘNotable traits for &'_ mut Rimpl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;

Notable traits for &'_ mut R

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut TⓘNotable traits for &'_ mut Rimpl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;

Notable traits for &'_ mut R

pub unsafe fn drop(ptr: usize)

impl<T, A> QueueableCommand<A> for T where T: Write, A: Display, [src]

pub fn queue( &mut self, command: impl Command<AnsiType = A>) -> Result<&mut T, ErrorKind>[src]

Arguments

Examples

Notes

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

`impl Debug for Sink`1.16.0[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl<'_> Write for &'_ Sink`1.48.0[src]

`pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>`[src]

`pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>`[src]

`pub fn is_write_vectored(&self) -> bool`[src]

`pub fn flush(&mut self) -> Result<(), Error>`[src]

`pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`[src]

`pub fn write_all_vectored( &mut self, bufs: &mut [IoSlice<'_>] ) -> Result<(), Error>`[src]

`pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>`[src]

`pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

`impl Write for Sink`[src]

`pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>`[src]

`pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>`[src]

`pub fn is_write_vectored(&self) -> bool`[src]

`pub fn flush(&mut self) -> Result<(), Error>`[src]

`pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`[src]

`pub fn write_all_vectored( &mut self, bufs: &mut [IoSlice<'_>] ) -> Result<(), Error>`[src]

`pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>`[src]

`pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

`impl RefUnwindSafe for Sink`[src]

`impl Send for Sink`[src]

`impl Sync for Sink`[src]

`impl Unpin for Sink`[src]

`impl UnwindSafe for Sink`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

`impl<T, A> ExecutableCommand<A> for T where T: Write, A: Display,` [src]

`pub fn execute( &mut self, command: impl Command<AnsiType = A> ) -> Result<&mut T, ErrorKind>`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Fun for T`[src]

`pub fn fun<F, D>(self, f: F) -> T where F: FnMut(&T) -> D,` [src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Pointable for T`

`pub const ALIGN: usize`

`type Init = T`

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`

`pub unsafe fn deref<'a>(ptr: usize) -> &'a TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut TⓘNotable traits for &'_ mut R impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

`pub unsafe fn drop(ptr: usize)`

`impl<T, A> QueueableCommand<A> for T where T: Write, A: Display,` [src]

`pub fn queue( &mut self, command: impl Command<AnsiType = A> ) -> Result<&mut T, ErrorKind>`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]