Struct GitHub

pub struct GitHub(/* private fields */);

Asynchronous GitHub API bindings that wraps octorust::Client internally.

Examples

use gfas_api::GitHub;

let github = GitHub::new(String::from("<TOKEN>"))?;

Implementations

impl GitHub

pub fn new(token: String) -> Result<Self, ClientError>

Create a new GitHub API client.

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

Paginates through the given user profile link and returns discovered followings/followers collected in HashSet.

Errors

Fails if an error occurs during sending requests.

Methods from Deref<Target = Client>

pub fn with_host_override<H>(&mut self, host: H) -> &mut Client

where H: ToString,

Override the host for all endpoins in the client.

pub fn remove_host_override(&mut self) -> &mut Client

Disables the global host override for the client.

pub fn get_host_override(&self) -> Option<&str>

pub fn set_credentials<CR>(&mut self, credentials: CR)

where CR: Into<Option<Credentials>>,

pub fn actions(&self) -> Actions

Endpoints to manage GitHub Actions using the REST API.

pub fn activity(&self) -> Activity

Activity APIs provide access to notifications, subscriptions, and timelines.

pub fn apps(&self) -> Apps

Information for integrations and installations.

pub fn billing(&self) -> Billing

Monitor charges and usage from Actions and Packages.

pub fn checks(&self) -> Checks

Rich interactions with checks run by your integrations.

pub fn code_scanning(&self) -> CodeScanning

Retrieve code scanning alerts from a repository.

pub fn codes_of_conduct(&self) -> CodesOfConduct

Insight into codes of conduct for your communities.

pub fn emojis(&self) -> Emojis

List emojis available to use on GitHub.

pub fn enterprise_admin(&self) -> EnterpriseAdmin

Administer a GitHub enterprise.

pub fn gists(&self) -> Gists

View, modify your gists.

pub fn git(&self) -> Git

Raw Git functionality.

pub fn gitignore(&self) -> Gitignore

View gitignore templates.

pub fn interactions(&self) -> Interactions

Owner or admin management of users interactions.

pub fn issues(&self) -> Issues

Interact with GitHub Issues.

pub fn licenses(&self) -> Licenses

View various OSS licenses.

pub fn markdown(&self) -> Markdown

Render Github flavored markdown.

pub fn meta(&self) -> Meta

Endpoints that give information about the API.

pub fn migrations(&self) -> Migrations

Move projects to or from GitHub.

pub fn oauth_authorizations(&self) -> OauthAuthorizations

Manage access of OAuth applications.

pub fn orgs(&self) -> Orgs

Interact with GitHub Orgs.

pub fn packages(&self) -> Packages

Manage packages for authenticated users and organizations.

pub fn projects(&self) -> Projects

Interact with GitHub Projects.

pub fn pulls(&self) -> Pulls

Interact with GitHub Pull Requests.

pub fn rate_limit(&self) -> RateLimit

Check your current rate limit status.

pub fn reactions(&self) -> Reactions

Interact with reactions to various GitHub entities.

pub fn repos(&self) -> Repos

Interact with GitHub Repos.

pub fn scim(&self) -> Scim

Provisioning of GitHub organization membership for SCIM-enabled providers.

pub fn search(&self) -> Search

Look for stuff on GitHub.

pub fn secret_scanning(&self) -> SecretScanning

Retrieve secret scanning alerts from a repository.

pub fn teams(&self) -> Teams

Interact with GitHub Teams.

pub fn users(&self) -> Users

Interact with and view information about users and also current user.

Trait Implementations

impl Clone for GitHub

fn clone(&self) -> GitHub

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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.