Struct ModuleTree 

pub struct ModuleTree {
    pub name: String,
    pub vis: PureVis,
    pub uses: Vec<PureUse>,
    pub inner_attrs: Vec<PureAttribute>,
    pub items: Vec<PureItem>,
    pub children: Vec<ModuleTree>,
}

A hierarchical module tree for source generation.

This structure represents a complete module hierarchy that can be transformed into source code by a SourceGenerator.

Example

// Build a tree representing:
// mod utils {
//     use std::io;
//     pub fn helper() {}
// }

let tree = ModuleTree::new("utils")
    .with_vis(PureVis::Public)
    .with_use(PureUse { ... })
    .with_item(PureItem::Fn(helper_fn));

Fields

name: String

Module name (empty string for crate root).

vis: PureVis

Module visibility.

uses: Vec<PureUse>

Use statements for this module.

inner_attrs: Vec<PureAttribute>

Inner attributes (e.g., //! doc, #![allow(...)]).

items: Vec<PureItem>

Items in this module (structs, functions, etc.).

children: Vec<ModuleTree>

Child modules.

Implementations

impl ModuleTree

pub fn new(name: impl Into<String>) -> Self

Create a new module tree with the given name.

For crate root, use an empty string or “crate”.

pub fn crate_root() -> Self

Create a crate root module tree.

pub fn with_vis(self, vis: PureVis) -> Self

Set visibility.

pub fn with_use(self, use_stmt: PureUse) -> Self

Add a use statement.

pub fn with_uses(self, uses: impl IntoIterator<Item = PureUse>) -> Self

Add multiple use statements.

pub fn with_inner_attr(self, attr: PureAttribute) -> Self

Add an inner attribute.

pub fn with_item(self, item: PureItem) -> Self

Add an item.

pub fn with_items(self, items: impl IntoIterator<Item = PureItem>) -> Self

Add multiple items.

pub fn with_child(self, child: ModuleTree) -> Self

Add a child module.

pub fn with_children( self, children: impl IntoIterator<Item = ModuleTree>, ) -> Self

Add multiple child modules.

pub fn is_crate_root(&self) -> bool

Check if this is the crate root.

pub fn total_items(&self) -> usize

Get total item count (including children).

pub fn total_modules(&self) -> usize

Get total module count (including self and children).

pub fn find_child(&self, name: &str) -> Option<&ModuleTree>

Find a child module by name.

pub fn find_child_mut(&mut self, name: &str) -> Option<&mut ModuleTree>

Find a child module by name (mutable).

pub fn get_or_create_child(&mut self, name: &str) -> &mut ModuleTree

Get or create a child module by name.

If a child with the given name exists, returns a mutable reference to it. Otherwise, creates a new child module and returns a mutable reference.

pub fn navigate(&self, path: &[&str]) -> Option<&ModuleTree>

Navigate to a nested module by path.

Path is a slice of module names, e.g., ["foo", "bar"] for foo::bar.

pub fn navigate_mut(&mut self, path: &[&str]) -> Option<&mut ModuleTree>

Navigate to a nested module by path (mutable).

pub fn get_or_create_path(&mut self, path: &[&str]) -> &mut ModuleTree

Get or create nested modules by path.

Creates any missing intermediate modules.

Trait Implementations

impl Clone for ModuleTree

fn clone(&self) -> ModuleTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleTree

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

Formats the value using the given formatter.

impl Default for ModuleTree

fn default() -> ModuleTree

Returns the “default value” for a type.