Struct Stuart

pub struct Stuart {
    pub dir: PathBuf,
    pub input: Option<Node>,
    pub output: Option<Node>,
    pub config: Config,
    pub base: Option<StackFrame>,
    pub plugins: Option<Box<dyn Manager>>,
}

The project builder.

Fields

dir: PathBuf

The input directory.

input: Option<Node>

The input virtual filesystem tree.

output: Option<Node>

The output virtual filesystem tree.

config: Config

The configuration of the project.

base: Option<StackFrame>

The base stack frame for each node.

plugins: Option<Box<dyn Manager>>

The plugins to be used by Stuart.

Implementations

impl Stuart

pub fn new(dir: impl AsRef<Path>) -> Self

Creates a new builder from an input directory.

pub fn new_from_node(node: Node) -> Self

Creates a new builder from a virtual filesystem tree. (for tests)

pub fn with_config(self, config: Config) -> Self

Sets the configuration to use.

pub fn with_plugins<T>(self, plugins: T) -> Self

where T: Manager + 'static,

Sets the plugin manager to use.

pub fn build(&mut self, stuart_env: String) -> Result<(), Error>

Attempts to build the project.

pub fn merge_output(&mut self, node: Node) -> Result<(), Error>

Merges an output node with the built result.

This is used for merging static content with the build output.

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), Error>

Saves the build output to a directory.

pub fn save_metadata(&self, path: impl AsRef<Path>) -> Result<(), Error>

Saves the build metadata to a file.