Struct heroku_rs::framework::HttpApiClient

pub struct HttpApiClient { /* fields omitted */ }

The client used to make requests to Heroku.

This struct contains the synchronous client.

Implementations

impl HttpApiClient

pub fn create(token: &str) -> Fallible<HttpApiClient>

Example 1:

Creating a simple client with the defaults. This has the production Heroku endpoint, 30 seconds timeout and the standard api key authentication.

use heroku_rs::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
   let api_client = HttpApiClient::create("API_KEY")?;

   // you can start making requests here

   Ok(())
}

pub fn new(
    credentials: Credentials,
    config: HttpApiClientConfig,
    environment: ApiEnvironment
) -> Fallible<HttpApiClient>

Example 2:

Creating a custom client in which you can specify the custom endpoint, timeouts and custom credentials.

This example is using a API key to authenticate, 10 second timeouts, and https://api.custom-somewhere.com/ base endpoint.

This is primarily used for testing / developement.

use heroku_rs::prelude::*;
use std::time::Duration;

fn main() -> Result<(), Box<dyn std::error::Error>> {
   let credentials = Credentials::UserAuthToken {
        token: String::from("API_KEY"),
   };

  let api_client = HttpApiClient::new(
   credentials,
   HttpApiClientConfig {
       http_timeout: Duration::from_secs(10),
       default_headers: http::HeaderMap::default(),
   },
   ApiEnvironment::Custom(url::Url::parse("https://api.custom-somewhere.com/").unwrap()))?;

   // you can start making requests here with api_client

   Ok(())
}

Trait Implementations

impl<'a> HerokuApiClient for HttpApiClient

fn request<ResultType, QueryType, BodyType>(
    &self,
    endpoint: &dyn HerokuEndpoint<ResultType, QueryType, BodyType>
) -> ApiResponse<ResultType> where
    ResultType: ApiResult,
    QueryType: Serialize,
    BodyType: Serialize, 

Synchronously send a request to the Heroku API.

fn request_raw<ResultType, QueryType, BodyType>(
    &self,
    endpoint: &dyn HerokuEndpoint<ResultType, QueryType, BodyType>
) -> ApiResponse<Response> where
    ResultType: ApiResult,
    QueryType: Serialize,
    BodyType: Serialize, 

This returns a Result<reqwest::blocking::Response, heroku_rs::framework::response::error::HerokuApiFailure>