Struct Module

pub struct Module {
    pub code: TokenStream,
    pub usings: BTreeSet<String>,
    pub modules: BTreeMap<String, Module>,
}

Manages the code that is generated for a specific module.

This type stores the generated code, the related using directives as well as any sub-module for a specific module generated by the code generator.

Fields

code: TokenStream

The actual code that is manages by this module.

usings: BTreeSet<String>

A set of using directives this module needs.

modules: BTreeMap<String, Module>

A map of sub-modules contained inside this module.

Implementations

impl Module

pub fn append(&mut self, code: TokenStream) -> &mut Self

Append the passed code to this module code.

pub fn prepend(&mut self, code: TokenStream) -> &mut Self

Prepend the passed code to this module code.

pub fn usings<I>(&mut self, usings: I) -> &mut Self

where I: IntoIterator, I::Item: ToString,

Add using directives to the set of this module.

pub fn module<T>(&self, ident: T) -> Option<&Module>

where T: AsRef<str>,

Get a reference to a sub-module identified by the passed ident.

If the module does not exist None is returned.

pub fn module_mut<T>(&mut self, ident: T) -> &mut Module

where T: Into<String>,

Get a mutable reference to a sub-module identified by the passed ident.

If the module does not exist it will be created.

pub fn to_code(&self, tokens: &mut TokenStream, sub_modules: SubModules)

Write the module to the passed token stream.

This method writes the current module to the passed token stream. The sub_modules parameter defines how the sub-modules of this module will be rendered.

pub fn write_to_files<P>(&self, directory: P) -> Result<(), IoError>

where P: AsRef<Path>,

Write the code of the current module to the passed directory.

This will split up the current module into it’s sub modules and writes them to the passed directory. Each sub-module is written to it’s own module file.

Errors

Returns an IoError if writing a module to a file failed.

pub fn write_to_files_with<F, E>(&self, f: F) -> Result<(), E>

where F: FnMut(&Module, &Path) -> Result<(), E>,

Write the code of the different sub-modules by using the passed function f.

This will split up the current module into it’s sub modules and passes the generated code for each module to the passed function f.

Errors

Forwards the error raised by f.

Trait Implementations

impl Debug for Module

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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Module

Returns the “default value” for a type.

impl ToTokens for Module

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.