Struct rustify::endpoint::MutatedEndpoint

pub struct MutatedEndpoint<'a, E: Endpoint, M: MiddleWare> { /* fields omitted */ }

Represents an Endpoint that has had MiddleWare applied to it.

This type wraps Endpoint by implementng it. The primary difference is when exec is called the request and response will potentially be mutated before processing. Only one MiddleWare can be applied to a single Endpoint.

Implementations

impl<'a, E: Endpoint, M: MiddleWare> MutatedEndpoint<'a, E, M>

pub fn new(endpoint: E, middleware: &'a M) -> Self

Returns a new MutatedEndpoint.

Trait Implementations

impl<'impl0, E: Endpoint, M: MiddleWare> Endpoint for MutatedEndpoint<'impl0, E, M>

type Response = E::Response

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

const REQUEST_BODY_TYPE: RequestType

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType

The content type of the response body

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>(
    &'life0 self,
    client: &'life1 impl Client
) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Executes the Endpoint using the given Client.

fn with_middleware<M: MiddleWare>(
    self,
    middleware: &M
) -> MutatedEndpoint<'_, Self, M>