Struct Pipeline 

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

Container for a service.

Provides a way to call the enclosed service and share its readiness state.

Implementations

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

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

pub fn new<S, St>(f: impl IntoService<S, St, Req>) -> Pipeline<Req, Res, Err>

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

Construct new service pipeline instance with default state.

pub fn with<S, St>( st: St, f: impl IntoService<S, St, Req>, ) -> Pipeline<Req, Res, Err>

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

Construct new service pipeline instance with state.

pub fn with_ctl<S, St, Ctl>( st: St, ctl: Ctl, f: impl IntoService<S, St, Req>, ) -> Pipeline<Req, Res, Err>

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

Construct new service pipeline instance with state.

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

Returns when the pipeline is ready to process requests.

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

Wait for service readiness, then create a future that resolves to the service call result.

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

Wait for service readiness, then create a future that resolves to the service result.

This call can be completed from different async tasks.

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

Call the service and create a future that resolves to the service result.

This call can be completed from different async tasks. Note: this call does not check service readiness.

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

Returns Ready when the pipeline is ready to process requests.

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>

Returns the current pipeline binding.

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<(), Error>

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.