Skip to main content

Task

Struct Task 

Source
pub struct Task<F> { /* private fields */ }
Expand description

Long-running work spawned in OnStart and joined in OnStop.

Created with task. OnStart returns as soon as the task is spawned. For bind/listen that must fail start, use task_with.

Trait Implementations§

Source§

impl<F> Debug for Task<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F, Fut> Hook for Task<F>
where F: FnOnce(Stopped) -> Fut + Send + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Source§

fn name(&self) -> &'static str

Label used in framework logs and hook failure messages. Does not affect execution order. Defaults to "unnamed"; override for clearer diagnostics. Avoid "unnamed" as an explicit override (indistinguishable from the default) and avoid empty strings.
Source§

fn attach_shutdown(&mut self, shutdown: Shutdowner)

Receives the process Shutdowner when the hook is Lifecycle::appended. Read more
Source§

fn on_start(&mut self) -> impl Future<Output = Result<()>> + Send

Run while the application starts. Hooks start in registration order, and a failure unwinds the ones that already ran.
Source§

async fn on_stop(&mut self) -> Result<()>

Run while the application stops, in reverse registration order.
Source§

fn has_start(&self) -> bool

Whether this hook runs an OnStart phase. Read more
Source§

fn has_stop(&self) -> bool

Whether this hook runs an OnStop phase.

Auto Trait Implementations§

§

impl<F> !RefUnwindSafe for Task<F>

§

impl<F> !UnwindSafe for Task<F>

§

impl<F> Freeze for Task<F>
where Option<F>: Freeze,

§

impl<F> Send for Task<F>
where Option<F>: Send,

§

impl<F> Sync for Task<F>
where Option<F>: Sync,

§

impl<F> Unpin for Task<F>
where Option<F>: Unpin,

§

impl<F> UnsafeUnpin for Task<F>
where Option<F>: UnsafeUnpin,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
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