Struct Module

pub struct Module {
    pub name: String,
    /* private fields */
}

Defines a module.

Fields

name: String

Module name

Implementations

impl Module

pub fn new(name: &str) -> Self

Return a new, blank module

pub fn scope(&mut self) -> &mut Scope

Returns a mutable reference to the module’s scope.

pub fn vis(&mut self, vis: &str) -> &mut Self

Set the module visibility.

pub fn import(&mut self, path: &str, ty: &str) -> &mut Self

Import a type into the module’s scope.

This results in a new use statement bein added to the beginning of the module.

pub fn new_module(&mut self, name: &str) -> &mut Self

Push a new module definition, returning a mutable reference to it.

Panics

Since a module’s name must uniquely identify it within the scope in which it is defined, pushing a module whose name is already defined in this scope will cause this function to panic.

In many cases, the get_or_new_module function is preferrable, as it will return the existing definition instead.

pub fn get_module<Q: ?Sized>(&self, name: &Q) -> Option<&Self>

where String: PartialEq<Q>,

Returns a reference to a module if it is exists in this scope.

pub fn get_module_mut<Q: ?Sized>(&mut self, name: &Q) -> Option<&mut Self>

where String: PartialEq<Q>,

Returns a mutable reference to a module if it is exists in this scope.

pub fn get_or_new_module(&mut self, name: &str) -> &mut Self

Returns a mutable reference to a module, creating it if it does not exist.

pub fn push_module(&mut self, item: Self) -> &mut Self

Push a module definition.

Panics

Since a module’s name must uniquely identify it within the scope in which it is defined, pushing a module whose name is already defined in this scope will cause this function to panic.

In many cases, the get_or_new_module function is preferrable, as it will return the existing definition instead.

pub fn new_struct(&mut self, name: &str) -> &mut Struct

Push a new struct definition, returning a mutable reference to it.

pub fn push_struct(&mut self, item: Struct) -> &mut Self

Push a structure definition

pub fn new_fn(&mut self, name: &str) -> &mut Function

Push a new function definition, returning a mutable reference to it.

pub fn push_fn(&mut self, item: Function) -> &mut Self

Push a function definition

pub fn new_enum(&mut self, name: &str) -> &mut Enum

Push a new enum definition, returning a mutable reference to it.

pub fn push_enum(&mut self, item: Enum) -> &mut Self

Push an enum definition

pub fn new_impl(&mut self, target: &str) -> &mut Impl

Push a new impl block, returning a mutable reference to it.

pub fn push_impl(&mut self, item: Impl) -> &mut Self

Push an impl block.

pub fn push_trait(&mut self, item: Trait) -> &mut Self

Push a trait definition

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

Formats the module using the given formatter.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.