Struct use_github_api::client::GithubClient [−][src]
pub struct GithubClient<'a> { /* fields omitted */ }
Expand description
Holds the reqwest client, auth token, base url, headers, user agent, etc.
Implementations
impl<'a> GithubClient<'a>
[src]
impl<'a> GithubClient<'a>
[src]pub fn new(
base_url: &'a str,
auth_token: &'a str
) -> Result<GithubClient<'a>, Box<dyn StdError>>
[src]
pub fn new(
base_url: &'a str,
auth_token: &'a str
) -> Result<GithubClient<'a>, Box<dyn StdError>>
[src]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>
[src]
pub fn builder() -> GithubClientBuilder<'a>
[src]Gives a GithubClientBuilder
, same as using GithubClientBuilder::new()
.
pub fn users(&self) -> Users<'_>
[src]
Trait Implementations
Auto Trait Implementations
impl<'a> !RefUnwindSafe for GithubClient<'a>
impl<'a> Send for GithubClient<'a>
impl<'a> Sync for GithubClient<'a>
impl<'a> Unpin for GithubClient<'a>
impl<'a> !UnwindSafe for GithubClient<'a>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]