Skip to main content

FmtToIo

Struct FmtToIo 

Source
pub struct FmtToIo<W> {
    pub error: Option<Error>,
    /* private fields */
}
Expand description

Adapter that enables writing through a fmt::Write to an underlying io::Write.

§Examples

use io_adapters::WriteExtension;

let mut output1 = String::new();
let mut output2 = [0u8; 13]; // Or io::stdout() for example

my_common_writer(&mut output1).unwrap();
my_common_writer(&mut output2.as_mut_slice().write_adapter()).unwrap();

fn my_common_writer(mut output: impl fmt::Write) -> fmt::Result {
    write!(output, "Hello, World!")
}

assert_eq!(&output1, "Hello, World!");
assert_eq!(str::from_utf8(&output2).unwrap(), "Hello, World!");

§Error handling

Error handling is unpleasant with this adapter due to the fmt::Write interface returning a stateless fmt::Error rather than an io::Error. Here is the suggested usage when unwrap doesn’t cut it:


let mut adapter = io::stdout().write_adapter();
match (conv(&mut adapter), adapter.error) {
  (Ok(()), None) => {}
  (Ok(()), Some(_)) => unreachable!(),
  (Err(fmt::Error), None) => { /* Handle format error. */ }
  (Err(fmt::Error), Some(e)) => { /* Handle I/O error. */ }
}

fn conv(output: impl fmt::Write) -> fmt::Result

Fields§

§error: Option<Error>

Trait Implementations§

Source§

impl<W: Debug> Debug for FmtToIo<W>

Source§

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

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

impl<W: Write> Write for FmtToIo<W>

Source§

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded. Read more
1.1.0 · Source§

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded. Read more
1.0.0 · Source§

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait. Read more

Auto Trait Implementations§

§

impl<W> !RefUnwindSafe for FmtToIo<W>

§

impl<W> !UnwindSafe for FmtToIo<W>

§

impl<W> Freeze for FmtToIo<W>
where W: Freeze,

§

impl<W> Send for FmtToIo<W>
where W: Send,

§

impl<W> Sync for FmtToIo<W>
where W: Sync,

§

impl<W> Unpin for FmtToIo<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for FmtToIo<W>
where W: UnsafeUnpin,

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 = 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<W> WriteExtension<FmtToIo<W>> for W
where W: Write,