Struct Pipeline 

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

Execution container for a service and its state.

A pipeline coordinates readiness, calls, and shutdown for the enclosed service chain.

Implementations

impl<Req, Res, Err> Pipeline<Req, Res, Err>

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

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

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

Creates a pipeline containing service and state.

pub async fn ready(&self) -> 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) -> Result<Res, Err>

Waits for readiness, then calls the service.

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

pub fn call_static(&self, req: Req) -> PipelineCall<Req, Res, Err>

Returns an owned future that waits for readiness and calls the service.

Unlike Pipeline::call, the returned future does not borrow the pipeline and can be moved between local tasks. The readiness check is skipped if the last pipeline readiness check succeeded and no call has started since; this is decided when the future is first polled.

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

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.

pub fn poll_shutdown(&self, cx: &mut Context<'_>) -> Poll<()>

Returns Ready when the service has been properly shut down.

pub fn is_shutdown(&self) -> bool

Checks whether pipeline shutdown has been initiated.

pub async fn shutdown(&self)

Shuts down the enclosed service.

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

Creates a new binding to this pipeline.

The binding can be used to check readiness and call the service.

Trait Implementations

impl<Req, Res, Err> Debug for Pipeline<Req, Res, Err>

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

Formats the value using the given formatter.

impl<Req, Res, Err> Drop for Pipeline<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.

impl<Req, Res, Err> ServiceCaller<Req, Res, Err> for Pipeline<Req, Res, Err>

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

async fn call_service(&self, req: Req) -> Result<Res, Err>

Waits for readiness, then calls the service.