Struct OutputToString

pub struct OutputToString { /* private fields */ }

Helper structure to help maintain an indentation level when printing source, modeled after the support in wit-bindgen-core. Indentation is set to two spaces.

Trait Implementations

impl Default for OutputToString

fn default() -> OutputToString

Returns the “default value” for a type.

impl Display for OutputToString

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

Formats the value using the given formatter.

impl From<OutputToString> for String

fn from(output: OutputToString) -> String

Converts to this type from the input type.

impl Output for OutputToString

fn push_str(&mut self, src: &str)

Push a string slice into a buffer or an output.

fn indent_if_needed(&mut self) -> bool

Set the appropriate indentation.

fn indent_start(&mut self)

Start of indentation. In WIT this represents {\n.

fn indent_end(&mut self)

End of indentation. In WIT this represents }\n.

fn newline(&mut self)

A newline is added.

fn indent_and_print(&mut self, src: &str)

This method is designed to be used only by the default methods of this trait. Called only from the default implementation functions of this trait.

fn keyword(&mut self, src: &str)

A keyword is added. Keywords are hardcoded strings from [a-z], but can start with @ when printing a Feature Gate

fn ty(&mut self, src: &str, _kind: TypeKind)

A type is added.

fn param(&mut self, src: &str)

A parameter name of a function, record or a named return is added.

fn case(&mut self, src: &str)

A case belonging to a variant, enum or flags is added.

fn generic_args_start(&mut self)

Generic argument section starts. In WIT this represents the < character.

fn generic_args_end(&mut self)

Generic argument section ends. In WIT this represents the ‘>’ character.

fn doc(&mut self, doc: &str)

Called when a single documentation line is added. The doc parameter starts with /// omitted, and can be an empty string.

fn semicolon(&mut self)

A semicolon is added.

fn str(&mut self, src: &str)

Any string that does not have a specialized function is added. Parameter src can contain punctation characters, and must be escaped when outputing to languages like HTML.