Struct Assemble

pub struct Assemble { /* private fields */ }

Provides a wrapper around the assemble instance that’s running this build.

Implementations

impl Assemble

pub fn new(start: StartParameter) -> Assemble

Create a new assemble instance

pub fn set_execution_graph( &mut self, graph: &ExecutionGraph, ) -> Result<(), PayloadError<ProjectError>>

Makes the execution graph available

pub fn add_listener<T>( &mut self, listener: T, ) -> Result<(), PayloadError<ProjectError>>

where T: Listener<Listened = Assemble>,

Add a listener to the inner freight

pub fn add_task_execution_listener<T>( &mut self, listener: T, ) -> Result<(), PayloadError<ProjectError>>

where T: TaskExecutionListener + 'static,

pub fn add_task_execution_graph_listener<T>( &mut self, listener: T, ) -> Result<(), PayloadError<ProjectError>>

where T: TaskExecutionGraphListener + 'static,

pub fn add_build_listener<T>( &mut self, listener: T, ) -> Result<(), PayloadError<ProjectError>>

where T: BuildListener + 'static,

pub fn settings_evaluated<S>( &mut self, settings: S, ) -> Result<(), PayloadError<ProjectError>>

where S: SettingsAware,

pub fn assemble_version(&self) -> &Version

Gets the current version of assemble

pub fn start_parameter(&self) -> &StartParameter

Gets the start parameters used to start this build

pub fn current_dir(&self) -> &Path

pub fn project_dir(&self) -> PathBuf

pub fn properties(&self) -> &HashMap<String, Option<String>>

Trait Implementations

impl AssembleAware for Assemble

fn with_assemble<F, R>(&self, func: F) -> R

where F: FnOnce(&Assemble) -> R,

Gets this Assemble instance.

fn with_assemble_mut<F, R>(&mut self, func: F) -> R

where F: FnOnce(&mut Assemble) -> R,

Get the assemble instance this value is aware of as a mutable reference

fn start_parameter(&self) -> StartParameter

impl Debug for Assemble

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

Formats the value using the given formatter.

impl Default for Assemble

fn default() -> Assemble

Returns the “default value” for a type.

impl PluginAware for Assemble

fn plugin_manager(&self) -> &PluginManager<Assemble>

Gets a reference to the plugin manager for this value.

fn plugin_manager_mut(&mut self) -> &mut PluginManager<Assemble>

Gets a mutable reference to the plugin manager for this value.

fn apply_plugin<P>(&mut self) -> Result<(), PayloadError<ProjectError>>

where P: Plugin<Self>,

Apply a plugin to this.