Struct Help

pub struct Help { /* private fields */ }

The help task. Defines help for the, well, task

Trait Implementations

impl CreateTask for Help

fn new( _using_id: &TaskId, _project: &Project, ) -> Result<Help, PayloadError<ProjectError>>

Creates a new task. The using_id is the id of the task that’s being created.

fn description() -> String

The default description for a Task

fn options_declarations() -> Option<OptionDeclarations>

Gets an optional flags for this task.

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

Try to get values from a decoder.

impl Debug for Help

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

Formats the value using the given formatter.

impl InitializeTask for Help

fn initialize( _task: &mut Executable<T>, _project: &Project, ) -> Result<(), PayloadError<ProjectError>>

Initialize tasks

impl Task for Help

fn task_action( task: &mut Executable<Help>, project: &Project, ) -> Result<(), PayloadError<BuildException>>

The action that the task performs

fn did_work(&self) -> bool

Check whether this task did work.

impl TaskIO for Help

fn configure_io( _task: &mut Executable<T>, ) -> Result<(), PayloadError<ProjectError>>

During the initialization of the task, configures the inputs and outputs of the task.

fn recover_outputs( &mut self, _output: &Output, ) -> Result<(), PayloadError<ProjectError>>

Recovers outputs from previous run if up-to-date

impl UpToDate for Help

fn up_to_date(&self) -> bool

Whether this value is up to date.