Prefixer

Struct Prefixer 

Source
pub struct Prefixer<'w> {
    pub first_line_prefix: String,
    pub next_line_prefix: String,
    pub writer: &'w mut dyn Write,
    pub is_first_line: bool,
    pub needs_prefix: bool,
}
Expand description

A Write adapter that prefixes each written line.

This type uses a dyn Write instead of impl Write to avoid a trait-recursion explosion in crate::writeln_error_to_writer.

Fields§

§first_line_prefix: String

Prefix for the very first line.

§next_line_prefix: String

Prefix for subsequent lines.

§writer: &'w mut dyn Write

The underlying writer.

§is_first_line: bool

Whether the next write is still on the first line.

§needs_prefix: bool

Whether the next write should include a prefix.

Implementations§

Source§

impl<'w> Prefixer<'w>

Source

pub fn new( first_line_prefix: impl Into<String>, next_line_prefix: impl Into<String>, writer: &'w mut dyn Write, ) -> Self

Creates a new prefixing writer with the provided line prefixes.

Trait Implementations§

Source§

impl<'w> Debug for Prefixer<'w>

Source§

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

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

impl<'w> Write for Prefixer<'w>

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

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

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

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

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<'w> Freeze for Prefixer<'w>

§

impl<'w> !RefUnwindSafe for Prefixer<'w>

§

impl<'w> !Send for Prefixer<'w>

§

impl<'w> !Sync for Prefixer<'w>

§

impl<'w> Unpin for Prefixer<'w>

§

impl<'w> !UnwindSafe for Prefixer<'w>

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.