Trait CallEndpoint 

pub trait CallEndpoint {
    type Args;
    type Response;

    // Required methods
    fn method() -> Method;
    fn build_path(args: &Self::Args) -> String;
    fn request_body(args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>;
    fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>;
}

Describes how to call a specific endpoint: what arguments it needs, how to build the URL, and how to parse the response.

Required Associated Types

type Args

The arguments needed to call this endpoint.

type Response

The response type returned on success.

Required Methods

fn method() -> Method

The HTTP method.

fn build_path(args: &Self::Args) -> String

Build the URL path by substituting captures into the pattern.

fn request_body(args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

Serialize the request body, if any.

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

Deserialize the response body.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<P, Req, Res, Q, Err> CallEndpoint for Endpoint<Patch, P, Req, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Req: Serialize, Res: DeserializeOwned,

type Args = (<P as PathSpec>::Captures, Req)

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

impl<P, Req, Res, Q, Err> CallEndpoint for Endpoint<Post, P, Req, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Req: Serialize, Res: DeserializeOwned,

type Args = (<P as PathSpec>::Captures, Req)

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

impl<P, Req, Res, Q, Err> CallEndpoint for Endpoint<Put, P, Req, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Req: Serialize, Res: DeserializeOwned,

type Args = (<P as PathSpec>::Captures, Req)

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

impl<P, Res, Q, Err> CallEndpoint for Endpoint<Delete, P, NoBody, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Res: DeserializeOwned,

type Args = <P as PathSpec>::Captures

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(_args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

impl<P, Res, Q, Err> CallEndpoint for Endpoint<Get, P, NoBody, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Res: DeserializeOwned,

type Args = <P as PathSpec>::Captures

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(_args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

impl<P, Res, Q, Err> CallEndpoint for Endpoint<Head, P, NoBody, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Res: DeserializeOwned,

type Args = <P as PathSpec>::Captures

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(_args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

impl<P, Res, Q, Err> CallEndpoint for Endpoint<Options, P, NoBody, Res, Q, Err>

where P: PathSpec + ExtractPath, P::Captures: BuildPath, Res: DeserializeOwned,

type Args = <P as PathSpec>::Captures

type Response = Res

fn method() -> Method

fn build_path(args: &Self::Args) -> String

fn request_body(_args: &Self::Args) -> Option<Result<Vec<u8>, ClientError>>

fn parse_response(bytes: &[u8]) -> Result<Self::Response, ClientError>

Implementors