Struct GithubClientBuilder

#[non_exhaustive]
pub struct GithubClientBuilder<'a> { /* private fields */ }

Available on crate feature auth only.

A GithubClient builder. Allows building a GithubClient while still setting options like the base URL and auth token. Only useful when either the auth or enterprise feature enabled.

Examples

use use_github_api::{GithubClient, GithubClientBuilder};
// If `enterprise` is enabled
let client = GithubClientBuilder::new().auth("adS*lkjha(&W3").base_url("https://gh.enterprise.org/api/v3").build().unwrap();
// If `enterprise` is not enabled
let client = GithubClientBuilder::new().auth("ghp_kajshdkja").build().unwrap();

Implementations

impl<'a> GithubClientBuilder<'a>

pub fn new() -> Self

Creates a new GithubClientBuilder.

pub fn build(self) -> Result<GithubClient<'a>, Box<dyn StdError>>

Builds the builder and returns a client.

Errors

If either the auth token or the base url is missing, this will error out.

pub fn auth(self, auth_token: &'a str) -> Self

Sets the auth token.

Examples

let builder = GithubClientBuilder::new();
let builder = builder.auth("my auth token");
// Build client and do stuff

pub fn base_url(self, base_url: &'a str) -> Self

Sets the base url.

Examples

let builder = GithubClientBuilder::new();
let builder = builder.base_url("https://something.com/api/v3");
// Build client and do stuff

Trait Implementations

impl<'a> Default for GithubClientBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.