TaskHandle

Struct TaskHandle 

Source
pub struct TaskHandle { /* private fields */ }
Expand description

Task handle for controlling and monitoring a task.

Implementations§

Source§

impl TaskHandle

Source

pub fn id(&self) -> &str

Get the task ID.

Source

pub fn info(&self) -> TaskInfo

Get current task information.

Source

pub fn status(&self) -> TaskStatus

Get the current status.

Source

pub fn progress(&self) -> u8

Get the current progress.

Source

pub fn set_progress(&self, progress: u8, message: Option<&str>)

Update the task progress.

Source

pub fn log(&self, level: &str, message: &str)

Publish a log message.

Source

pub fn stdout(&self, line: &str)

Publish stdout output.

Source

pub fn stderr(&self, line: &str)

Publish stderr output.

Source

pub fn is_cancelled(&self) -> bool

Check if cancellation has been requested.

Source

pub fn cancel_token(&self) -> CancellationToken

Get the cancellation token.

Source

pub fn start(&self)

Mark the task as started.

Source

pub fn complete(&self, result: Value)

Mark the task as completed with a result.

Source

pub fn fail(&self, error: &str)

Mark the task as failed with an error.

Source

pub fn publisher(&self) -> &EventPublisher

Get the event publisher for this task.

Trait Implementations§

Source§

impl Clone for TaskHandle

Source§

fn clone(&self) -> TaskHandle

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoMetered for T

Source§

fn metered(self, metrics: Arc<ChannelMetrics>) -> MeteredSender<Self>

Wrap this sender with metrics tracking.
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithMetrics for T

Source§

fn with_metrics(self) -> MeteredWrapper<Self>

Wrap this channel with metrics tracking.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more