Struct Executable

pub struct Executable<T>
where
    T: Task,
{
    pub task: T,
    /* private fields */
}

The wrapped task itself

Fields

task: T

Implementations

impl<T> Executable<T>

where T: 'static + Task + Send + Debug,

pub fn new<Id>(shared: SharedProject, task: T, task_id: Id) -> Executable<T>

where Id: AsRef<TaskId>,

pub fn initialize( &mut self, project: &Project, ) -> Result<(), PayloadError<ProjectError>>

Initialize the executable.

pub fn configure_io(&mut self) -> Result<(), PayloadError<ProjectError>>

Configures the io of this executable. Ran after the task is initialized.

pub fn depends_on<B>(&mut self, buildable: B)

where B: IntoBuildable, <B as IntoBuildable>::Buildable: 'static,

pub fn do_first<F>(&mut self, a: F) -> Result<(), PayloadError<ProjectError>>

where F: Fn(&mut Executable<T>, &Project) -> Result<(), PayloadError<BuildException>> + 'static + Send + Sync,

pub fn do_last<F>(&mut self, a: F) -> Result<(), PayloadError<ProjectError>>

where F: Fn(&mut Executable<T>, &Project) -> Result<(), PayloadError<BuildException>> + 'static + Send + Sync,

pub fn project(&self) -> SharedProject

pub fn work(&mut self) -> &mut WorkHandler

pub fn set_description(&mut self, description: &str)

pub fn set_group(&mut self, group: &str)

pub fn up_to_date<F>(&mut self, configure: F)

where F: Fn(&Executable<T>) -> bool + Send + Sync + 'static,

Add an up-to-date check

Trait Implementations

impl<T> BuildableTask for Executable<T>

where T: 'static + Task + Send + Debug,

fn ordering(&self) -> Vec<TaskOrdering>

Gets the total ordering associated with the task. This includes all types of ordering, including those that aren’t strict dependencies.

fn built_by(&self) -> BuiltByContainer

Gets the tasks that this task depends on

impl<T> Debug for Executable<T>

where T: Task + Debug,

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

Formats the value using the given formatter.

impl<AT> Dependency for Executable<AT>

where AT: ArtifactTask,

fn id(&self) -> String

A way of identifying dependencies

fn dep_type(&self) -> DependencyType

The type of the dependency

fn try_resolve( &self, _: &dyn Registry, _: &Path, ) -> Result<ResolvedDependency, AcquisitionError>

Try to resolve a dependency in a registry. The cache_path is somewhere to write files into if necessary.

impl<T> Deref for Executable<T>

where T: Task,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Executable<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Executable<T>

where T: Task,

fn deref_mut(&mut self) -> &mut <Executable<T> as Deref>::Target

Mutably dereferences the value.

impl<T> ExecutableTask for Executable<T>

where T: 'static + Task + Send + Sync + Debug,

fn options_declarations(&self) -> Option<OptionDeclarations>

Get the options declaration for this task

fn try_set_from_decoder( &mut self, decoder: &OptionsDecoder<'_>, ) -> Result<(), PayloadError<ProjectError>>

Try to set values from a decoder

fn execute( &mut self, project: &Project, ) -> Result<(), PayloadError<BuildException>>

Executes the task, with a given project

fn did_work(&self) -> bool

Checks if this task did work

fn task_up_to_date(&self) -> bool

Check if this task marked itself as up to date

fn group(&self) -> String

Gets the group of the task

fn description(&self) -> String

Gets the description of the task

impl<AT> GetBuildable for Executable<AT>

where AT: ArtifactTask,

fn as_buildable(&self) -> BuildableObject

Returns a dependency which contains the tasks which build this object.

impl<T> HasTaskId for Executable<T>

where T: 'static + Task + Send + Debug,

fn task_id(&self) -> TaskId

Gets the task id

impl<T> IntoBuildable for &Executable<T>

where T: Task + Send + Debug,

type Buildable = BuiltByContainer

fn into_buildable(self) -> <&Executable<T> as IntoBuildable>::Buildable

Returns a dependency which contains the tasks which build this object.