Struct gfas_api::GitHub

pub struct GitHub { /* private fields */ }

Asynchronous GitHub API bindings that wraps a reqwest::Client internally.

Examples

use gfas_api::{BuilderExt, GitHub};

let github = GitHub::builder().token("<token>").endpoint("https://api.github.com".parse()?)?;

Implementations

impl GitHub

pub fn builder() -> ClientBuilder

Alias for reqwest::ClientBuilder::new().

pub async fn explore(&self, user: &str, role: &str) -> Result<HashSet<String>>

Paginates through the given user profile link and returns discovered users collected in HashSet.

role should be either "following" or "followers".

Errors

Fails if an error occurs during sending requests.

pub async fn follow(&self, user: &str) -> Result<Response>

Follows a user.

Errors

Fails if an error occurs during sending the request.

pub async fn unfollow(&self, user: &str) -> Result<Response>

Unfollows a user.

Errors

Fails if an error occurs during sending the request.

Methods from Deref<Target = Client>

pub fn get<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a GET request to a URL.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn post<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a POST request to a URL.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn put<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a PUT request to a URL.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn patch<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a PATCH request to a URL.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn delete<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a DELETE request to a URL.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn head<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a HEAD request to a URL.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn request<U>(&self, method: Method, url: U) -> RequestBuilder

where U: IntoUrl,

Start building a Request with the Method and Url.

Returns a RequestBuilder, which will allow setting headers and the request body before sending.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub fn execute( &self, request: Request, ) -> impl Future<Output = Result<Response, Error>>

Executes a Request.

A Request can be built manually with Request::new() or obtained from a RequestBuilder with RequestBuilder::build().

You should prefer to use the RequestBuilder and RequestBuilder::send().

Errors

This method fails if there was an error while sending request, redirect loop was detected or redirect limit was exhausted.

Trait Implementations

impl Clone for GitHub

fn clone(&self) -> GitHub

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GitHub

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for GitHub

type Target = Client

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for GitHub

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.