Struct Pipeline 

pub struct Pipeline(/* private fields */);

Execution pipeline.

A pipeline follows a precise flow:

1. Client library-specified per-call policies are executed. Per-call policies can fail and bail out of the pipeline immediately.
2. User-specified per-call policies in ClientOptions::per_call_policies are executed.
3. The retry policy is executed. It allows to re-execute the following policies.
4. Client library-specified per-retry policies. Per-retry polices are always executed at least once but are re-executed in case of retries.
5. User-specified per-retry policies in ClientOptions::per_try_policies are executed.
6. The transport policy is executed. Transport policy is always the last policy and is the policy that actually constructs the AsyncRawResponse to be passed up the pipeline.

A pipeline is immutable. In other words a policy can either succeed and call the following policy of fail and return to the calling policy. Arbitrary policy “skip” must be avoided (but cannot be enforced by code). All policies except Transport policy can assume there is another following policy (so self.pipeline[0] is always valid).

Implementations

impl Pipeline

pub fn new( crate_name: Option<&'static str>, crate_version: Option<&'static str>, options: ClientOptions, per_call_policies: Vec<Arc<dyn Policy>>, per_try_policies: Vec<Arc<dyn Policy>>, pipeline_options: Option<PipelineOptions>, ) -> Self

Creates a new pipeline given the client library crate name and version, alone with user-specified and client library-specified policies.

Crates can simply pass option_env!("CARGO_PKG_NAME") and option_env!("CARGO_PKG_VERSION") for the crate_name and crate_version arguments respectively.

Arguments

• crate_name - The name of the crate implementing the client library.
• crate_version - The version of the crate implementing the client library.
• options - The client options.
• per_call_policies - Policies to be executed per call, before the policies in ClientOptions::per_call_policies.
• per_try_policies - Policies to be executed per try, before the policies in ClientOptions::per_try_policies.
• pipeline_options - Additional options for the pipeline. If None, default options will be used.

pub async fn send( &self, ctx: &Context<'_>, request: &mut Request, options: Option<PipelineSendOptions>, ) -> Result<RawResponse>

Sends a Request through each configured Policy to get a RawResponse that is processed by each policy in reverse.

Arguments

• ctx - The context for the Request.
• request - The Request to send.
• options - Options for sending the Request, including check success options. If none, check_success will not be called.

Returns

A http::RawResponse if the request was successful, or an Error if it failed. If the response status code indicates an HTTP error, the function will attempt to parse the error response body into an ErrorResponse and include it in the Error.

pub async fn stream( &self, ctx: &Context<'_>, request: &mut Request, options: Option<PipelineStreamOptions>, ) -> Result<AsyncRawResponse>

Sends a Request through each configured Policy to get a AsyncRawResponse that is processed by each policy in reverse.

Arguments

• ctx - The context for the Request.
• request - The Request to send.
• options - Options for sending the Request, including check success options. If none, check_success will not be called.

Returns

A http::RawResponse if the request was successful, or an Error if it failed. If the response status code indicates an HTTP error, the function will attempt to parse the error response body into an ErrorResponse and include it in the Error.

Trait Implementations

impl Clone for Pipeline

fn clone(&self) -> Pipeline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pipeline

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

Formats the value using the given formatter.