Struct overclock::core::BoundedHandle

pub struct BoundedHandle<T> { /* private fields */ }

Bounded handle

Implementations

impl<T> BoundedHandle<T>

pub fn new(
    sender: Sender<T>,
    gauge: IntGauge,
    abort_handle: AbortHandle,
    scope_id: ScopeId
) -> Self

Create new bounded handle

pub async fn send(&self, message: T) -> Result<(), SendError<T>>

Send message to the bounded channel

pub fn send_after(
    &self,
    message: T,
    duration: Duration
) -> JoinHandle<Result<(), SendError<T>>> where
    T: Send + 'static, 

Send message to the channel after the duration pass

pub async fn closed(&self)

Await till the channel is closed

pub fn try_send(&self, message: T) -> Result<(), TrySendError<T>>

Attempt to send message to the bounded channel

pub fn is_closed(&self) -> bool

check if the channel is closed

pub fn same_channel(&self, other: &Self) -> bool

Returns true if the handle belongs to same channel

Trait Implementations

impl<T> Clone for BoundedHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BoundedHandle<T>

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

Formats the value using the given formatter.

impl<M: 'static + Send, E: Send> Route<M> for BoundedHandle<E> where
    E: TryFrom<M>,
    E::Error: Send, 

fn try_send_msg<'life0, 'async_trait>(
    &'life0 self,
    message: M
) -> Pin<Box<dyn Future<Output = Result<Option<M>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Try to send message to the channel.

fn send_msg<'life0, 'async_trait>(
    &'life0 self,
    message: M
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

if the Route is behind lock, drop the lock before invoking this method.

impl<E: 'static + ShutdownEvent> Shutdown for BoundedHandle<E>

fn shutdown<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Send shutdown signal to the corresponding actor

fn scope_id(&self) -> ScopeId

Return the corresponding actor’s scope_id