Skip to main content

SaturatorHandle

Struct SaturatorHandle 

Source
pub struct SaturatorHandle<T> { /* private fields */ }
Expand description

Handle to send work to a saturator.

The handle is cheap to clone and can be shared across threads. When all handles are dropped, the saturator will finish processing remaining work and shut down.

Implementations§

Source§

impl<T: Send + 'static> SaturatorHandle<T>

Source

pub fn submit(&self, work: T, scope: Option<&EventScope>)

Submit high-priority work with optional scope tracking.

Follows the EventScope pattern from event_bus.rs:252-259: scope is incremented before submit and decremented after completion.

§Arguments
  • work - The work data to process
  • scope - Optional scope for lifecycle tracking
Source

pub fn submit_background(&self, work: T, scope: Option<&EventScope>)

Submit low-priority background work.

§Arguments
  • work - The work data to process
  • scope - Optional scope for lifecycle tracking
Source

pub fn submit_request(&self, request: SaturationRequest<T>)

Submit a request with explicit priority.

Source

pub fn shutdown(&self)

Request shutdown of the saturator.

The worker will finish processing remaining items before stopping.

Source

pub fn is_shutting_down(&self) -> bool

Check if the saturator is shutting down.

Trait Implementations§

Source§

impl<T> Clone for SaturatorHandle<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Drop for SaturatorHandle<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for SaturatorHandle<T>

§

impl<T> !RefUnwindSafe for SaturatorHandle<T>

§

impl<T> Send for SaturatorHandle<T>
where T: Send,

§

impl<T> Sync for SaturatorHandle<T>
where T: Send,

§

impl<T> Unpin for SaturatorHandle<T>

§

impl<T> UnsafeUnpin for SaturatorHandle<T>

§

impl<T> !UnwindSafe for SaturatorHandle<T>

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, 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 = 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.