Struct Indenter

pub struct Indenter<'a, Opt: IndentedOptions<'a>> { /* private fields */ }

The public face of the library, this is the type that must be created to use the crate::IndentedDisplay trait

This utilizes a std::fmt::Write formatter as its output, a base indent string that is used for all levels of indentation (unless overridden individually by indentation frames), and an options structure that contains options that may be interrogated by the implementation of crate::IndentedDisplay

Implementations

impl<'a, Opt: IndentedOptions<'a>> Indenter<'a, Opt>

pub fn new(fmt: &'a mut (dyn Write + 'a), s: &'a str, options: &'a Opt) -> Self

Create a new Indenter, to be used with types that implement the crate::IndentedDisplay trait; this specifies the formatter, the base indentation string, and the options for the indentation

pub fn sub(&self) -> Self

Create a new subframe of the Indenter using its base indentation for this indentation level; this is invoked by the indent function in an crate::IndentedDisplay trait implementation to create subframes of indentation. The subframe is removed from the indentation output stack when it is dropped, so it must either go out of scope or be explicitly dropped.

pub fn push(&self, s: &'a str) -> Self

Create a new subframe of the Indenter using a specific string, indentation for this indentation level; this is invoked by the indent function in an crate::IndentedDisplay trait implementation to create subframes of indentation. The subframe is removed from the indentation output stack when it is dropped, so it must either go out of scope or be explicitly dropped.

Currently the string must outlive the Indenter - usually this means it is static.

pub fn pop(self) -> Self

Pop this subframe and return its parent

pub fn options(&self) -> &Opt

Borrow the options used to invoke the Indenter.

This may be invoked by the indent function in an crate::IndentedDisplay trait implementation to determine the setting of indentation options that may affect its output.

Trait Implementations

impl<'a, Opt: IndentedOptions<'a>> Write for Indenter<'a, Opt>

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

Writes a string slice into this writer, returning whether the write succeeded.

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

Writes a char into this writer, returning whether the write succeeded.

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

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