Struct GitHubBuilder 

pub struct GitHubBuilder { /* private fields */ }

GitHub Builder

Implementations

impl GitHubBuilder

pub fn instance(&mut self, instance: &str) -> &mut Self

Set the Instance URL for the GitHub Enterprise Server.

Example

use ghastoolkit::GitHub;

let github = GitHub::init()
    .instance("https://github.geekmasher.dev/")
    .build()
    .expect("Failed to initialise GitHub instance");

pub fn token(&mut self, token: &str) -> &mut Self

Set the Token used to authenticate with GitHub.

Example

use ghastoolkit::GitHub;

let github = GitHub::init()
    .token("personal_access_token")
    .build()
    .expect("Failed to initialise GitHub instance");

pub fn owner(&mut self, owner: &str) -> &mut Self

Set the Owner (Username or Organization).

pub fn enterprise(&mut self, enterprise: &str) -> &mut Self

Set the Enterprise Account name.

pub fn github_app(&mut self, github_app: bool) -> &mut Self

Set the GitHub App flag. This is mainly used for changing the rate limits and other settings.

pub fn build(&self) -> Result<GitHub, GHASError>

Build the GitHub instance with the provided settings.

Example

use ghastoolkit::GitHub;

let github = GitHub::init()
    .instance("https://github.geekmasher.dev/")
    .owner("geekmasher")
    .token("personal_access_token")
    .build()
    .expect("Failed to initialise GitHub instance");

Trait Implementations

impl Clone for GitHubBuilder

fn clone(&self) -> GitHubBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitHubBuilder

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

Formats the value using the given formatter.

impl Default for GitHubBuilder

fn default() -> Self

Returns the “default value” for a type.