Skip to main content

Generator

Struct Generator 

Source
pub struct Generator {
    pub executer: Arc<dyn Executer>,
    pub settings: Settings,
}
Expand description

The Generator struct provides functionality to execute scripted operations, such as copying files and templates, based on the current settings.

Fields§

§executer: Arc<dyn Executer>§settings: Settings

Implementations§

Source§

impl Generator

Source

pub fn new(executer: Arc<dyn Executer>, settings: Settings) -> Self

Creates a new Generator with a given executor and settings.

Source

pub fn run(&self) -> Result<()>

Runs the default script.

§Errors

Returns an error if the script execution fails.

Source

pub fn run_from_script(&self, script: &str) -> Result<()>

Runs a custom script provided as a string.

§Errors

Returns an error if the script execution fails.

Source

pub fn copy_file(&mut self, path: &str) -> Result<(), Box<EvalAltResult>>

Copies a single file from the specified path.

§Errors

Returns an error if the file copy operation fails.

Source

pub fn create_file( &mut self, path: &str, content: &str, ) -> Result<(), Box<EvalAltResult>>

Creates a single file in the specified path.

§Errors

Returns an error if the file copy operation fails.

Source

pub fn copy_files(&mut self, paths: Array) -> Result<(), Box<EvalAltResult>>

Copies list of files from the specified path.

§Errors

Returns an error if the file copy operation fails.

Source

pub fn copy_dir(&mut self, path: &str) -> Result<(), Box<EvalAltResult>>

Copies an entire directory from the specified path.

§Errors

Returns an error if the directory copy operation fails.

Source

pub fn copy_dirs(&mut self, paths: Array) -> Result<(), Box<EvalAltResult>>

Copies list of directories from the specified path.

§Errors

Returns an error if the directory copy operation fails.

Source

pub fn copy_template(&mut self, path: &str) -> Result<(), Box<EvalAltResult>>

Copies a template file from the specified path, applying settings.

§Errors

Returns an error if the template copy operation fails.

Source

pub fn copy_template_dir( &mut self, path: &str, ) -> Result<(), Box<EvalAltResult>>

Copies an entire template directory from the specified path, applying settings.

§Errors

Returns an error if the template directory copy operation fails.

Trait Implementations§

Source§

impl Clone for Generator

Source§

fn clone(&self) -> Generator

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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