Struct TaskHandle

pub struct TaskHandle<T>
where
    T: Task + Send + Sync + Debug + 'static,
{ /* private fields */ }

Implementations

impl<T> TaskHandle<T>

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

pub fn id(&self) -> &TaskId

Gets the id of the created task.

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

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

pub fn provides<F, R>(&self, func: F) -> TaskProvider<T, R, F>

where F: Fn(&Executable<T>) -> R + Send + Sync, R: Clone + Send + Sync,

Trait Implementations

impl<T> Buildable for TaskHandle<T>

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

fn get_dependencies( &self, project: &Project, ) -> Result<HashSet<TaskId>, PayloadError<ProjectError>>

Gets the dependencies required to build this task

impl<T> BuildableTask for TaskHandle<T>

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

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> Clone for TaskHandle<T>

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

fn clone(&self) -> TaskHandle<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TaskHandle<T>

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

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

Formats the value using the given formatter.

impl<AT> Dependency for TaskHandle<AT>

where AT: ArtifactTask + Send + 'static,

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> ExecutableTask for TaskHandle<T>

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

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<T> From<TaskHandle<T>> for FileSet

where T: ArtifactTask,

fn from(t: TaskHandle<T>) -> FileSet

Converts to this type from the input type.

impl<T> HasTaskId for TaskHandle<T>

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

fn task_id(&self) -> TaskId

Gets the task id

impl<A> IntoArtifact for &TaskHandle<A>

where A: ArtifactTask,

type IntoArtifact = ConfigurableArtifact

fn into_artifact(self) -> <&TaskHandle<A> as IntoArtifact>::IntoArtifact

Get an artifact from some type

impl<A> IntoArtifact for TaskHandle<A>

where A: ArtifactTask,

type IntoArtifact = ConfigurableArtifact

fn into_artifact(self) -> <TaskHandle<A> as IntoArtifact>::IntoArtifact

Get an artifact from some type

impl<T> Provider<PathBuf> for TaskHandle<T>

where T: SinglePathOutputTask,

fn try_get(&self) -> Option<PathBuf>

Try to get a value from the provider.

fn missing_message(&self) -> String

The missing message for this provider

fn get(&self) -> T

Get a value from the provider.

fn fallible_get(&self) -> Result<T, ProviderError>

Tries to get a value from this provider, returning an error if not available.

impl<T> ResolveExecutable for TaskHandle<T>

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

fn get_executable( &mut self, project: &SharedProject, ) -> Result<Box<dyn FullTask>, PayloadError<ProjectError>>

impl<T> ResolveInnerTask for TaskHandle<T>

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

fn resolve_task( &mut self, project: &SharedProject, ) -> Result<(), PayloadError<ProjectError>>

impl<T> UpToDate for TaskHandle<T>

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

fn up_to_date(&self) -> bool

Whether this value is up to date.