Struct Sidejob 

pub struct Sidejob<Req, Reply> { /* private fields */ }

Handle to a sidejob actor.

Sidejob is cheap to clone: clones share the same underlying channel and overload counter, so spreading the handle across dispatcher tasks does not change the back-pressure semantics.

Implementations

impl<Req, Reply> Sidejob<Req, Reply>

where Req: Send + 'static, Reply: Send + 'static,

pub fn spawn<F, Fut>(name: &'static str, capacity: usize, handler: F) -> Self

where F: FnMut(Req) -> Fut + Send + 'static, Fut: Future<Output = Reply> + Send + 'static,

Spawn a new sidejob actor.

name is recorded as the name label on sidejob_overload_total and used in tracing log lines. capacity is the maximum number of in-flight requests the mailbox will hold before it starts rejecting submits with SidejobError::Overloaded.

The handler is FnMut so callers may close over mutable state; because the actor loop is serial, the handler is called against one request at a time.

Panics

Panics if capacity is zero. A zero-capacity sidejob would reject every submit and is almost certainly a configuration mistake.

pub async fn submit(&self, req: Req) -> Result<Reply, SidejobError>

Submit a request and await the handler’s reply.

Returns SidejobError::Overloaded immediately if the mailbox is full, or SidejobError::Stopped if the actor (or this specific request’s per-request task) has gone away before producing a reply.

pub fn try_submit(&self, req: Req) -> Result<Receiver<Reply>, SidejobError>

Submit a request without awaiting the reply.

On success the caller receives the oneshot::Receiver for the reply and may await it (or drop it) at leisure. Like Sidejob::submit, a full mailbox returns SidejobError::Overloaded immediately.

pub fn full_failures(&self) -> u64

Number of submits this handle has observed being rejected with SidejobError::Overloaded over its entire lifetime. Cloned handles share the same counter.

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

Static name used for metric labels.

Trait Implementations

impl<Req, Reply> Clone for Sidejob<Req, Reply>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Req, Reply> Debug for Sidejob<Req, Reply>

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

Formats the value using the given formatter.