Trait Endpoint

pub trait Endpoint {
    // Required methods
    fn method(&self) -> Method;
    fn endpoint(&self) -> Cow<'static, str>;

    // Provided methods
    fn parameters(&self) -> QueryParams<'_> { ... }
    fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> { ... }
}

A trait for providing the necessary information for a single REST API endpoint.

Required Methods

fn method(&self) -> Method

The HTTP method to use for the endpoint.

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

The path to the endpoint.

Provided Methods

fn parameters(&self) -> QueryParams<'_>

Query parameters for the endpoint.

fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError>

The body for the endpoint.

Returns the Content-Encoding header for the data as well as the data itself.

Errors

This method returns an error if the body could not be serialized to JSON.

Implementors

impl Endpoint for Currencies

impl Endpoint for Timezones

impl<'a> Endpoint for Dividends<'a>

impl<'a> Endpoint for Eod<'a>

impl<'a> Endpoint for Exchanges<'a>

impl<'a> Endpoint for Intraday<'a>

impl<'a> Endpoint for Splits<'a>

impl<'a> Endpoint for Tickers<'a>