Skip to main content

MonitorContext

Struct MonitorContext 

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

A handle to the monitor which allows probing Shared context for the monitor, providing access to the shutdown handle and the set of workers it supervises.

Implementations§

Source§

impl MonitorContext

Source

pub fn workers(&self) -> &Vec<WorkerContext>

Returns a reference to all workers managed by this monitor.

Source

pub fn shutdown(&self) -> Result<(), MonitorError>

Initiates a shutdown of the monitor.

This signals the shutdown handle but does not block waiting for workers to finish.

Source

pub fn resume_worker(&self, name: &str) -> Result<(), WorkerError>

Resumes the worker with the given name.

§Errors

Returns WorkerError if no worker with name exists, or if the resume itself fails.

Source

pub fn pause_worker(&self, name: &str) -> Result<(), WorkerError>

Pauses the worker with the given name.

§Errors

Returns WorkerError if no worker with name exists, or if pausing fails.

Source

pub fn stop_worker(&self, name: &str) -> Result<(), WorkerError>

Stops the worker with the given name.

§Errors

Returns WorkerError if no worker with name exists, or if stopping fails.

Source

pub fn wake_worker(&self, name: &str) -> Result<(), WorkerError>

Wakes the worker with the given name.

§Errors

Returns WorkerError if no worker with name exists.

Source

pub fn get_worker(&self, name: &str) -> Result<&WorkerContext, WorkerError>

Looks up a worker by name.

§Errors

Returns WorkerError::StateError if no worker with name exists among the managed workers.

Source

pub fn cancel_task( &self, worker: &str, task_id: &str, ) -> Result<(), BoxDynError>

Available on crate feature task-context only.

Attempt to cancel a task

Trait Implementations§

Source§

impl Clone for MonitorContext

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MonitorContext

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> CloneToUninit for T
where T: Clone,

Source§

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
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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