Struct FileTreeNode 

pub struct FileTreeNode {
    pub node_type: NodeType,
    pub name: String,
    pub children: Vec<FileTreeNode>,
    pub content: Option<String>,
    pub template: Option<String>,
    pub mode: Option<u32>,
}

A node in the file tree template

Represents either a file or directory in the generated file tree. Directory nodes can contain children, while file nodes contain content or reference template files.

Examples

Creating a directory node

use ggen_core::templates::format::FileTreeNode;

let dir = FileTreeNode::directory("src");
assert_eq!(dir.name, "src");

Creating a file node with content

use ggen_core::templates::format::FileTreeNode;

let file = FileTreeNode::file_with_content("main.rs", "fn main() {}");
assert_eq!(file.name, "main.rs");
assert_eq!(file.content, Some("fn main() {}".to_string()));

Fields

node_type: NodeType

Type of node (file or directory)

name: String

Name of the file or directory (may contain template variables)

children: Vec<FileTreeNode>

Children nodes (for directories)

content: Option<String>

Inline content (for files)

template: Option<String>

Template file reference (for files)

mode: Option<u32>

File permissions (Unix mode)

Implementations

impl FileTreeNode

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

Create a new directory node

Creates a directory node with no children. Children can be added using add_child().

Arguments

• name - Directory name (may contain template variables like {{ name }})

Returns

A new FileTreeNode with NodeType::Directory.

Examples

use ggen_core::templates::format::{FileTreeNode, NodeType};

let dir = FileTreeNode::directory("src");
assert_eq!(dir.node_type, NodeType::Directory);
assert_eq!(dir.name, "src");
assert!(dir.children.is_empty());

pub fn file_with_content( name: impl Into<String>, content: impl Into<String>, ) -> Self

Create a new file node with inline content

Creates a file node with inline content that will be written directly to the generated file. The content may contain template variables.

Arguments

• name - File name (may contain template variables)
• content - File content (may contain template variables)

Returns

A new FileTreeNode with NodeType::File and inline content.

Examples

use ggen_core::templates::format::{FileTreeNode, NodeType};

let file = FileTreeNode::file_with_content("main.rs", "fn main() {}");
assert_eq!(file.node_type, NodeType::File);
assert_eq!(file.name, "main.rs");
assert_eq!(file.content, Some("fn main() {}".to_string()));

pub fn file_with_template( name: impl Into<String>, template: impl Into<String>, ) -> Self

Create a new file node with template reference

Creates a file node that references an external template file. The template will be loaded and rendered during generation.

Arguments

• name - File name (may contain template variables)
• template - Path to template file (relative to template base directory)

Returns

A new FileTreeNode with NodeType::File and a template reference.

Examples

use ggen_core::templates::format::{FileTreeNode, NodeType};

let file = FileTreeNode::file_with_template("lib.rs", "templates/lib.rs.tera");
assert_eq!(file.node_type, NodeType::File);
assert_eq!(file.name, "lib.rs");
assert_eq!(file.template, Some("templates/lib.rs.tera".to_string()));

pub fn add_child(&mut self, child: FileTreeNode) -> &mut Self

Add a child node (for directories)

Adds a child node to this directory. Only valid for directory nodes. Returns &mut Self for method chaining.

Arguments

• child - Child node to add

Returns

&mut Self for method chaining.

Examples

use ggen_core::templates::format::FileTreeNode;

let mut dir = FileTreeNode::directory("src");
dir.add_child(FileTreeNode::file_with_content("main.rs", "fn main() {}"));

assert_eq!(dir.children.len(), 1);
assert_eq!(dir.children[0].name, "main.rs");

pub fn with_mode(self, mode: u32) -> Self

Set file permissions

Sets Unix file permissions (mode) for this file node. Only valid for file nodes. Returns Self for method chaining.

Arguments

• mode - Unix file mode (e.g., 0o755 for executable)

Returns

Self for method chaining.

Examples

use ggen_core::templates::format::FileTreeNode;

let file = FileTreeNode::file_with_content("script.sh", "#!/bin/bash")
    .with_mode(0o755);

assert_eq!(file.mode, Some(0o755));

Trait Implementations

impl Clone for FileTreeNode

fn clone(&self) -> FileTreeNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileTreeNode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileTreeNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileTreeNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.