Control

Enum Control 

Source
pub enum Control {
Show 17 variants Start, Stop, GracefulStop { signal: Signal, grace: Duration, }, TryRestart, TryGracefulRestart { signal: Signal, grace: Duration, }, ContinueTryGracefulRestart, Signal(Signal), Delete, NextEnding, SyncFunc(Box<dyn FnOnce(&JobTaskContext<'_>) + Send + Sync + 'static>), AsyncFunc(Box<dyn FnOnce(&JobTaskContext<'_>) -> Box<dyn Future<Output = ()> + Send + Sync> + Send + Sync + 'static>), SetSyncSpawnHook(Arc<dyn Fn(&mut TokioCommandWrap, &JobTaskContext<'_>) + Send + Sync + 'static>), SetAsyncSpawnHook(Arc<dyn Fn(&mut TokioCommandWrap, &JobTaskContext<'_>) -> Box<dyn Future<Output = ()> + Send + Sync> + Send + Sync + 'static>), UnsetSpawnHook, SetSyncErrorHandler(Arc<dyn Fn(SyncIoError) + Send + Sync + 'static>), SetAsyncErrorHandler(Arc<dyn Fn(SyncIoError) -> Box<dyn Future<Output = ()> + Send + Sync> + Send + Sync + 'static>), UnsetErrorHandler,
}
Expand description

The underlying control message types for Job.

You may use Job::control() to send these messages directly, but in general should prefer the higher-level methods on Job itself.

Variants§

§

Start

§

Stop

§

GracefulStop

Fields

§signal: Signal

Signal to send immediately

§grace: Duration

Time to wait before forceful termination

§

TryRestart

§

TryGracefulRestart

Fields

§signal: Signal

Signal to send immediately

§grace: Duration

Time to wait before forceful termination and restart

§

ContinueTryGracefulRestart

Internal implementation detail of Control::TryGracefulRestart.

§

Signal(Signal)

§

Delete

§

NextEnding

§

SyncFunc(Box<dyn FnOnce(&JobTaskContext<'_>) + Send + Sync + 'static>)

§

AsyncFunc(Box<dyn FnOnce(&JobTaskContext<'_>) -> Box<dyn Future<Output = ()> + Send + Sync> + Send + Sync + 'static>)

§

SetSyncSpawnHook(Arc<dyn Fn(&mut TokioCommandWrap, &JobTaskContext<'_>) + Send + Sync + 'static>)

§

SetAsyncSpawnHook(Arc<dyn Fn(&mut TokioCommandWrap, &JobTaskContext<'_>) -> Box<dyn Future<Output = ()> + Send + Sync> + Send + Sync + 'static>)

§

UnsetSpawnHook

§

SetSyncErrorHandler(Arc<dyn Fn(SyncIoError) + Send + Sync + 'static>)

§

SetAsyncErrorHandler(Arc<dyn Fn(SyncIoError) -> Box<dyn Future<Output = ()> + Send + Sync> + Send + Sync + 'static>)

§

UnsetErrorHandler

Trait Implementations§

Source§

impl Debug for Control

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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 = Infallible

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

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

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