Struct Ctx 

pub struct Ctx<'a, Svc, St = ()>
where
    Svc: ?Sized,
{ /* private fields */ }

Context provided to Service lifecycle methods.

A context gives a service access to pipeline state and coordinates calls to inner services with the pipeline’s readiness and shutdown machinery.

Implementations

impl<'a, Svc, St> Ctx<'a, Svc, St>

pub fn id(&self) -> u32

Returns the identifier of the current pipeline binding.

pub fn st(&'a self) -> &'a St

Returns the pipeline state.

pub async fn ready<S, Req>( &self, svc: &'a S, ) -> Result<(), <S as Service<St, Req>>::Error>

where S: Service<St, Req>,

Waits until svc is ready to process a request.

pub async fn call<S, Req>( &self, svc: &'a S, req: Req, ) -> Result<<S as Service<St, Req>>::Res, <S as Service<St, Req>>::Error>

where S: Service<St, Req>,

Waits for svc to become ready, then calls it.

pub async fn call_nowait<S, Req>( &self, svc: &'a S, req: Req, ) -> Result<<S as Service<St, Req>>::Res, <S as Service<St, Req>>::Error>

where S: Service<St, Req>,

Calls svc without checking readiness.

The caller must ensure that svc is ready.

pub async fn poll_fn<F, R>(&'a self, f: F) -> R

where F: Fn(&mut Context<'a>) -> Poll<R>,

Polls a closure until completion using the dispatcher’s task Context.

The Context uses the waker of the task that currently owns the readiness check. Outside of a readiness check a no-op waker is used, so a Pending result is not woken. If the current owner is not the main runner, the main runner is also scheduled for wake-up.

pub fn poll_once<F, R>(&'a self, f: F) -> R

where F: FnOnce(&mut Context<'a>) -> R,

Calls a closure once with the dispatcher’s task Context.

The Context uses the waker of the task that currently owns the readiness check. Outside of a readiness check a no-op waker is used, so a Pending result is not woken. If the current owner is not the main runner, the main runner is also scheduled for wake-up.

pub async fn shutdown<S, Req>(&self, svc: &'a S)

where S: Service<St, Req>,

Shuts down svc.

pub fn map_state<NewSt>( &'a self, st: &'a NewSt, ) -> Ctx<'a, Ctx<'a, Svc, St>, NewSt>

Returns a context that uses st as its state.

Trait Implementations

impl<S, St> Clone for Ctx<'_, S, St>

fn clone(&self) -> Ctx<'_, S, St>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S, St> Copy for Ctx<'_, S, St>

impl<S, St> Debug for Ctx<'_, S, St>

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

Formats the value using the given formatter.

impl<S, St> Deref for Ctx<'_, S, St>

type Target = St

The resulting type after dereferencing.

fn deref(&self) -> &St

Dereferences the value.