Struct GithubClient

pub struct GithubClient<'a> { /* private fields */ }

Holds the reqwest client, auth token, base url, headers, user agent, etc.

Implementations

impl<'a> GithubClient<'a>

pub fn new( base_url: &'a str, auth_token: &'a str, ) -> Result<GithubClient<'a>, Box<dyn StdError>>

Creates a new GithubClient which can be used to send requests.

Signature

The signatures of the function changes when the features are changed.

• When no features are enabled, the signature is fn () -> Result<GithubClient<'a>, Box<dyn StdError>>
• When the auth feature is enabled, the signature is fn (auth_token: &'a str) -> Result<GithubClient<'a>, Box<dyn StdError>>
• When the enterprise feature is enabled, the signature is fn fn (base_url: &'a str, auth_token: &'a str) -> Result<GithubClient<'a>, Box<dyn StdError>>

Arguments

Base URL

The base url can be like this: https://somehostfor.github.enterprise.org/api/v3. Do make sure to add the https:// and the /api/v3.

Auth Token

If using a PAT (personal access token), you can obtain one from https://github.com/settings/tokens.

Errors

Will error if the protocol is not http:// or https://, and will also error if the base URL does not include /api/v3. Will also error if the reqwest client fails to build.

Examples

use use_github_api::GithubClient;
let client = GithubClient::new("ghp_akjsdh").unwrap(); // DO NOT ACTUALLY HARDCODE TOKENS IN YOUR APP!!!
// do something with `client`

pub fn builder() -> GithubClientBuilder<'a>

Gives a GithubClientBuilder, same as using GithubClientBuilder::new().

pub fn users(&self) -> Users<'_>

Trait Implementations

impl<'a> Debug for GithubClient<'a>

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

Formats the value using the given formatter.