Struct Formatter

pub struct Formatter { /* private fields */ }

Collect source code to be written to a file and keep track of indentation.

Implementations

impl Formatter

pub fn new(lang: Language) -> Self

Source code formatter class. Used to collect source code of a specific Language to be written to a file, and keep track of indentation.

pub fn indent_push(&mut self)

Increase current indentation level by one.

pub fn indent_pop(&mut self)

Decrease indentation by one level.

pub fn indent<T, F: FnOnce(&mut Formatter) -> T>(&mut self, f: F) -> T

Increase indentation level for the duration of f.

pub fn line(&mut self, contents: impl AsRef<str>)

Add an indented line.

pub fn line_with_location( &mut self, contents: impl AsRef<str>, location: FileLocation, )

Add an indented lin with a given a location appended as a comment to the line (this is useful for identifying where a line was generated).

pub fn empty_line(&mut self)

Pushes an empty line.

pub fn multi_line(&mut self, s: &str)

Add one or more lines after stripping common indentation.

pub fn comment(&mut self, s: impl AsRef<str>)

Add a comment line.

pub fn doc_comment(&mut self, contents: impl AsRef<str>)

Add a (multi-line) documentation comment.

pub fn add_block<T, F: FnOnce(&mut Formatter) -> T>( &mut self, start: &str, f: F, ) -> T

Add a brace-delimited block that begins with start: i.e., <start> { <f()> }. This properly indents the contents of the block.

pub fn add_match(&mut self, m: Match)

Add a match expression.

pub fn write( &self, filename: impl AsRef<Path>, directory: &Path, ) -> Result<(), Error>

Write self.lines to a file.