Struct octocat_rs::github::http::HttpClient

pub struct HttpClient { /* private fields */ }

An implementer of the Requester trait. This is all most users will need, however it may be helpful to look at the trait implementation details here if you’re writing your own implementation.

Implementations

impl HttpClient

pub fn new(auth: Option<Authorization>, user_agent: Option<String>) -> Self

Creates a new HttpClient.

pub fn new_none() -> Self

Creates a new HttpClient with no authorization.

pub fn set_auth(&mut self, auth: Authorization)

Updates the authorization used by the current client.

pub fn set_ua(&mut self, user_agent: &str)

Set the user agent used by the current client.

Trait Implementations

impl Requester for HttpClient

fn raw_req<'life0, 'life1, 'async_trait, T, V>( &'life0 self, url: EndPoints, query: Option<&'life1 T>, body: Option<V> ) -> Pin<Box<dyn Future<Output = Result<String, GithubRestError>> + Send + 'async_trait>>where T: Serialize + ?Sized + Send + Sync + 'async_trait, V: Into<Self::Body> + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the API response as a String.

fn req<'life0, 'life1, 'async_trait, T, V, A>( &'life0 self, url: EndPoints, query: Option<&'life1 T>, body: Option<V> ) -> Pin<Box<dyn Future<Output = Result<A, GithubRestError>> + Send + 'async_trait>>where T: Serialize + ?Sized + Send + Sync + 'async_trait, V: Into<Self::Body> + Send + 'async_trait, A: 'async_trait + DeserializeOwned, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A function for performing HTTP requests utilizing the EndPoints enum.

Usage example:

HttpClient::new_none()
    .req::<GetCommitsBody, String, Commits>(
        EndPoints::GetReposownerrepoCommits("octocat-rs".to_owned(), "octocat-rs".to_owned()),
            None,
            None,
        )
        .await;

type Body = Body