FileTreeGenerator

Struct FileTreeGenerator 

Source
pub struct FileTreeGenerator { /* private fields */ }
Expand description

File tree generator for creating directory structures from templates

Takes a FileTreeTemplate and a TemplateContext, then generates the corresponding file tree in the filesystem with variable substitution.

§Examples

use ggen_core::templates::generator::FileTreeGenerator;
use ggen_core::templates::{FileTreeTemplate, TemplateContext};
use ggen_core::templates::format::TemplateFormat;
use std::path::Path;

let format = TemplateFormat::new("my-template");
let template = FileTreeTemplate::new(format);
let context = TemplateContext::new();

let mut generator = FileTreeGenerator::new(template, context, Path::new("output"));
let result = generator.generate()?;

Implementations§

Source§

impl FileTreeGenerator

Source

pub fn new<P: AsRef<Path>>( template: FileTreeTemplate, context: TemplateContext, base_dir: P, ) -> Self

Create a new file tree generator

§Arguments
  • template - The file tree template to generate from
  • context - Variable context for template rendering
  • base_dir - Base directory where files will be generated
§Examples
use ggen_core::templates::generator::FileTreeGenerator;
use ggen_core::templates::{FileTreeTemplate, TemplateContext};
use ggen_core::templates::format::TemplateFormat;
use std::path::Path;

let format = TemplateFormat::new("my-template");
let template = FileTreeTemplate::new(format);
let context = TemplateContext::new();

let generator = FileTreeGenerator::new(template, context, Path::new("output"));
Source

pub fn generate(&mut self) -> Result<GenerationResult>

Generate the file tree from the template

This method:

  1. Validates that all required variables are provided
  2. Applies default values for optional variables
  3. Processes each node in the template tree
  4. Creates directories and files with rendered content
§Errors

Returns an error if:

  • Required variables are missing
  • Template rendering fails
  • File system operations fail
§Examples
use ggen_core::templates::generator::FileTreeGenerator;
use ggen_core::templates::{FileTreeTemplate, TemplateContext};
use ggen_core::templates::format::{TemplateFormat, FileTreeNode};
use std::path::Path;

let mut format = TemplateFormat::new("my-template");
format.add_node(FileTreeNode::directory("src"));
let template = FileTreeTemplate::new(format);
let context = TemplateContext::new();

let mut generator = FileTreeGenerator::new(template, context, Path::new("output"));
let result = generator.generate()?;
println!("Generated {} directories", result.directories().len());
Source

pub fn template(&self) -> &FileTreeTemplate

Get the template being used

Source

pub fn context(&self) -> &TemplateContext

Get the context being used

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,