Struct FormatBuffer

pub struct FormatBuffer<W> {
    pub w: W,
    indents: Vec<IndentGroup>,
    base_indent_len: usize,
    tab_width: usize,
    last_char: Option<char>,
    current_line_len: usize,
    restrict_to_single_line: bool,
    state: WriteState,
}

A wrapper around a std::fmt::Write interface. The wrapper keeps track of indentation as well as information about the last write_str command if available. The formatter may also be restricted to a single line, in which case it will throw an error on a newline

Fields

w: W

indents: Vec<IndentGroup>

base_indent_len: usize

tab_width: usize

last_char: Option<char>

current_line_len: usize

restrict_to_single_line: bool

state: WriteState

Implementations

impl<W> FormatBuffer<W>

pub fn new(w: W, tab_width: usize) -> Self

pub fn create_temp_buf(&self) -> FormatBuffer<String>

Create a new temporary buffer based on an existing buffer which retains information about the buffer state, but has a blank String as its underlying Write interface

pub fn restrict_to_single_line(&mut self, restricted: bool)

Restrict the buffer to a single line

pub fn indent(&mut self, delta: usize)

Indent the buffer by delta

pub fn dedent(&mut self, delta: usize)

Dedent the buffer by delta

fn level(&self) -> usize

Get the current level of the indent. This is multiplied by the tab width to get the resulting indent

pub fn last_indent_group_skipped(&self) -> bool

Check if the last indent group is being skipped

pub fn set_last_indent_group_skipped(&mut self, skip_line: bool)

Set whether the last indent group should be skipped

pub fn current_indent_len(&self) -> usize

Get the current indent size (level * tab_width)

pub fn total_indent_len(&self) -> usize

Get the total indent size

pub fn current_line_len(&self) -> usize

Get the current written position (this does not include the indent size)

pub fn is_beginning_of_line(&self) -> bool

Check if the buffer is at the beginning of a new line

pub fn start_group(&mut self)

Start a new indent group (skips first indent)

pub fn end_group(&mut self)

End the last indent group

pub fn last_char(&self) -> Option<char>

Get the last char written to the buffer

fn handle_newline(&mut self, comment_state: CommentState)

When writing a newline apply state changes

impl<W: Write> FormatBuffer<W>

pub fn write_raw(&mut self, s: impl AsRef<str>) -> Result

Write a raw string to the buffer. This will ignore indents and remove the indents of the written string to match the current base indent of this buffer if it is a temp buffer

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

Trait Implementations

impl<W: Clone> Clone for FormatBuffer<W>

fn clone(&self) -> FormatBuffer<W>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W: Debug> Debug for FormatBuffer<W>

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

Formats the value using the given formatter.

impl<W: Write> Write for FormatBuffer<W>

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

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.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.