Struct zamm_yang::codegen::template::basic::ModuleFragment

pub struct ModuleFragment { /* fields omitted */ }

Fragment for a module declaration.

Implementations

impl ModuleFragment

pub fn new(name: String) -> Self

Create a new module with the given name.

pub fn new_file_module() -> Self

Create a new module that takes up an entire file.

pub fn new_test_module() -> Self

Create a new module with the name tests.

pub fn add_submodule(&mut self, name: String) -> Rc<RefCell<ModuleFragment>>

Adds a submodule to the current module.

pub fn mark_as_test(&mut self)

Mark a module as being a test module.

pub fn mark_as_entire_file(&mut self)

Mark this for generation as an entire file. Skips generation of the mod preamble.

pub fn re_export(&mut self, export: String)

Re-export something so that it looks like it comes from this module.

This usually, but not always, refers to something hidden within a submodule of this module. You can also re-export things from other modules, and they will also appear as if they came from this one.

pub fn append(&mut self, fragment: Rc<RefCell<dyn CodeFragment>>)

Add a fragment to the internals of this module.

Trait Implementations

impl CodeFragment for ModuleFragment

pub fn body(&self) -> String

Retrieve main body of code in this fragment.

pub fn imports(&self) -> Vec<String>

Retrieve all imports used by this fragment.

impl Default for ModuleFragment

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for ModuleFragment

impl ItemDeclarationAPI for ModuleFragment

pub fn mark_as_public(&mut self)

Mark this as a public declaration.

pub fn is_public(&self) -> bool

Whether this has been marked as a public declaration or not.

pub fn add_attribute(&mut self, attribute: String)

Add an attribute to the declaration.

pub fn document(&mut self, documentation: String)

Set the documentation for the fragment.

pub fn set_body(&mut self, body: Rc<RefCell<dyn CodeFragment>>)

Set an implementation to go along with the declaration.

pub fn mark_as_declare_only(&mut self)

Declares the item without implementing it.

pub fn mark_for_full_implementation(&mut self)

Mark the module as requiring full implementation, even if that implementation is an empty one.

impl Ord for ModuleFragment

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ModuleFragment> for ModuleFragment

pub fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ModuleFragment> for ModuleFragment

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.