Struct Indented

pub struct Indented<'a, D: ?Sized> { /* private fields */ }

Helper struct for efficiently indenting multi line display implementations

Explanation

This type will never allocate a string to handle inserting indentation. It instead leverages the write_str function that serves as the foundation of the core::fmt::Write trait. This lets it intercept each piece of output as its being written to the output buffer. It then splits on newlines giving slices into the original string. Finally we alternate writing these lines and the specified indentation to the output buffer.

Implementations

impl<'a, D: ?Sized> Indented<'a, D>

pub fn ind(self, ind: usize) -> Self

Sets the format to Format::Numbered with the provided index

pub fn with_str(self, indentation: &'static str) -> Self

Sets the format to Format::Uniform with the provided static string

pub fn with_format(self, format: Format<'a>) -> Self

Construct an indenter with a user defined format

pub fn into_inner(self) -> &'a mut D

Returns the inner writer.

Trait Implementations

impl<T> WriteStr for Indented<'_, T>

where T: WriteStr + ?Sized,

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

Writes a string to the writer.

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

Flushes the writer, ensuring that all intermediately buffered contents reach their destination.

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

Writes a single character to the writer.

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

Writes a formatted string to the writer.