Struct ore::codegen::CodegenBuf

pub struct CodegenBuf {
    inner: String,
    level: usize,
}

A code generation buffer.

A CodegenBuf provides a string-based API for generating Rust code. Its value is in the various function it provides to automatically manage indentation.

Fields

inner: String

level: usize

Implementations

impl CodegenBuf

pub fn new() -> CodegenBuf

Creates a new code generation buffer.

pub fn into_string(self) -> String

Consumes the buffer, returning its contents.

pub fn write<S>(&mut self, s: S) where
    S: AsRef<str>, 

Writes a string into the buffer directly.

pub fn writeln<S>(&mut self, s: S) where
    S: AsRef<str>, 

Writes a line into the buffer at the current indentation level.

Specifically, the method writes (4 * indentation level) spaces into the buffer, followed by s, followed by a newline character.

pub fn start_line(&mut self)

Starts a new line.

Specifically, the method writes (4 * indentation level) spaces into the buffer.

pub fn end_line(&mut self)

Ends the current line.

Specifically, the method writes a newline character into the buffer.

pub fn start_block<S>(&mut self, s: S) where
    S: AsRef<str>, 

Starts a new indented block.

Specifically, if s is empty, the method writes the line { into the buffer; otherwise writes the line s { into the buffer at the current identation level. Then it increments the buffer’s indentation level.

pub fn restart_block<S>(&mut self, s: S) where
    S: AsRef<str>, 

Closes the current indented block and starts a new one at the same identation level.

Specifically, the method writes the line } s { into the buffer at one less than the buffer’s indentation level.

Panics

Panics if the current indentation level is zero.

pub fn end_block(&mut self)

Ends the current indented block.

Specifically, the method decrements the current indentation level, then writes a line containing } into the buffer.

Panics

Panics if the current indentation level is zero.

Trait Implementations

impl Clone for CodegenBuf

fn clone(&self) -> CodegenBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodegenBuf

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

Formats the value using the given formatter.

impl Default for CodegenBuf

fn default() -> CodegenBuf

Returns the “default value” for a type.