Trait RestRequest

pub trait RestRequest {
    type Response: DeserializeOwned;
    type QueryParams: Serialize;
    type Body: Serialize;

    // Required methods
    fn path(&self) -> Cow<'static, str>;
    fn method() -> Method;

    // Provided methods
    fn query_params(&self) -> Option<&Self::QueryParams> { ... }
    fn body(&self) -> Option<&Self::Body> { ... }
    fn timeout() -> Duration { ... }
}

Http REST request that can be executed by a RestClient.

Required Associated Types

type Response: DeserializeOwned

Expected response type if this request was successful.

type QueryParams: Serialize

Serialisable query parameters type - use unit struct () if not required for this request.

type Body: Serialize

Serialisable Body type - use unit struct () if not required for this request.

Required Methods

fn path(&self) -> Cow<'static, str>

Additional Url path to the resource.

fn method() -> Method

Http reqwest::Method of this request.

Provided Methods

fn query_params(&self) -> Option<&Self::QueryParams>

Optional query parameters for this request.

fn body(&self) -> Option<&Self::Body>

Optional Body for this request.

fn timeout() -> Duration

Http request timeout Duration.

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.

Implementors