Struct zamm_yang::codegen::template::basic::ItemDeclaration

pub struct ItemDeclaration {
    pub doc: Option<String>,
    pub public: bool,
    pub attributes: Vec<String>,
    pub definition: Rc<RefCell<dyn CodeFragment>>,
    pub body: Option<Rc<RefCell<dyn CodeFragment>>>,
}

Fragment containing all universal modifiers for an item declaration.

Fields

doc: Option<String>

Documentation string for the item.

public: bool

Whether or not this item should be publicly exported out of the module.

attributes: Vec<String>

Attributes to be added to the item.

definition: Rc<RefCell<dyn CodeFragment>>

Actual definition of the item, whether it be a variable, function, or module.

body: Option<Rc<RefCell<dyn CodeFragment>>>

Some items, such as functions and submodules, may have actual implementations that go along with their declaration.

Implementations

impl ItemDeclaration

pub fn new(definition: Rc<RefCell<dyn CodeFragment>>) -> Self

Create a new item declaration.

pub fn set_definition(&mut self, definition: Rc<RefCell<dyn CodeFragment>>)

Set the fragment that defines this item.

Trait Implementations

impl Clone for ItemDeclaration

pub fn clone(&self) -> ItemDeclaration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CodeFragment for ItemDeclaration

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 ItemDeclaration

pub fn default() -> Self

Returns the "default value" for a type.

impl ItemDeclarationAPI for ItemDeclaration

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.