Struct PipelineState 

pub struct PipelineState<St, Req, Res, Err> { /* private fields */ }

Execution container for a service whose state is supplied per operation.

Unlike crate::Pipeline, this type does not own a state value. Callers provide a state reference when checking readiness, calling, or shutting down the service.

Implementations

impl<St, Req, Res, Err> PipelineState<St, Req, Res, Err>

where St: 'static, Req: 'static, Res: 'static, Err: 'static,

pub fn new<S>(service: impl IntoService<S, St, Req>) -> Self

where S: Service<St, Req, Res = Res, Error = Err> + 'static, St: 'static,

Creates a state-independent pipeline containing service.

pub async fn ready(&self, st: &St) -> Result<(), Err>

Returns when the pipeline is ready to process requests.

A successful check is consumed by the next call, which then skips its own readiness check.

pub async fn call(&self, req: Req, st: &St) -> Result<Res, Err>

Waits for readiness, then calls the service with st.

The readiness check is skipped if the last pipeline readiness check succeeded and no call has started since.

pub async fn shutdown(&self, st: &St)

Shuts down the enclosed service.

pub fn poll_ready(&self, cx: &mut Context<'_>, st: &St) -> Poll<Result<(), Err>>

where St: Clone,

Returns Ready when the pipeline is ready to process requests.

A successful check is consumed by the next call, which then skips its own readiness check.

Panics

Panics if .shutdown() has been called. Unlike crate::Pipeline::poll_ready, it does not return Ready(Ok(())) after shutdown.

pub fn bind(&self) -> PipelineStateBinding<St, Req, Res, Err>

Creates a binding that accepts state per call.

The binding can be used to call the service.

pub fn bind_state(&self, st: St) -> PipelineBinding<Req, Res, Err>

where St: Clone,

Creates a standard pipeline binding by attaching an owned state value.

The binding can be used to call the service.

Trait Implementations

impl<St, Req, Res, Err> Debug for PipelineState<St, Req, Res, Err>

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

Formats the value using the given formatter.

impl<St, Req, Res, Err> Drop for PipelineState<St, Req, Res, Err>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.