Struct roy::Client

pub struct Client {
    pub base_url: String,
    // some fields omitted
}

The HTTP client

Fields

base_url: String

API base URL

Implementations

impl Client

pub fn new(base_url: String) -> Client

Create a new instance of a Client

Usage:

use roy::Client;

let c = Client::new("https://httpbin.org".to_string());
assert_eq!(c.base_url, "https://httpbin.org");

pub fn new_auth(base_url: String, auth_token: &'static str) -> Client

Create a new instance of an authenticated Client

Usage:

use roy::Client;
use tokio_test::block_on;

let c = Client::new_auth("https://httpbin.org".to_string(), "");
assert_eq!(block_on(c.get("/bearer", false)).is_some(), true);

pub async fn post<T: Serialize + Debug, '_, '_>(
    &'_ self,
    endpoint: &'_ str,
    data: T
) -> Option<Response>

Generic function to POST data to an endpoint

Usage:

use roy::Client;
use tokio_test::block_on;

let c = Client::new("https://httpbin.org".to_string());
assert_eq!(block_on(c.post("/post", "{data}")).is_some(), true);

pub async fn delete<'_, '_>(&'_ self, endpoint: &'_ str) -> Option<Response>

Generic function to DELETE to an endpoint

Usage:

use roy::Client;
use tokio_test::block_on;

let c = Client::new("https://httpbin.org".to_string());
assert_eq!(block_on(c.delete("/delete")).is_some(), true);

pub async fn patch<T: Serialize + Debug, '_, '_>(
    &'_ self,
    endpoint: &'_ str,
    data: T
) -> Option<Response>

Generic function to PATCH data to an endpoint

Usage:

use roy::Client;
use tokio_test::block_on;

let c = Client::new("https://httpbin.org".to_string());
assert_eq!(block_on(c.patch("/patch", "{data}")).is_some(), true);

pub async fn put<T: Serialize + Debug, '_, '_>(
    &'_ self,
    endpoint: &'_ str,
    data: T
) -> Option<Response>

Generic function to PUT data to an endpoint

Usage:

use roy::Client;
use tokio_test::block_on;

let c = Client::new("https://httpbin.org".to_string());
assert_eq!(block_on(c.put("/put", "{data}")).is_some(), true);

pub async fn get<'_, '_>(
    &'_ self,
    endpoint: &'_ str,
    single: bool
) -> Option<Response>

Generic function to send a GET request to an endpoint

Usage:

use roy::Client;
use tokio_test::block_on;

let c = Client::new("https://httpbin.org".to_string());
assert_eq!(block_on(c.get("/get", false)).is_some(), true);