Struct Github 

pub struct Github { /* private fields */ }

A GitHub API client for one token. Requests on one URL are conditional on its last ETag, so an unchanged answer costs no rate limit.

Implementations

impl Github

pub fn new(base: &str, token_source: TokenSource) -> Result<Github, Error>

A client for base (API_URL, or a test server) that takes its token from token_source.

pub fn blocked_until(&self) -> Option<SystemTime>

When the next request may be sent: None now, otherwise when the rate limit resets.

Trait Implementations

impl Debug for Github

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

Formats the value using the given formatter.

impl GithubApi for Github

async fn queued_jobs(&self, repository: &str) -> Result<Vec<QueuedJob>, Error>

The repository’s jobs waiting for a runner, in queued runs and in runs that started some of their jobs.

async fn runners(&self, repository: &str) -> Result<Vec<Runner>, Error>

The repository’s self-hosted runners.

async fn jit_config( &self, repository: &str, name: &str, labels: &[String], ) -> Result<(Runner, JitConfig), Error>

Registers a runner for one job and returns it with the config run.sh --jitconfig takes.

async fn delete_runner( &self, repository: &str, id: u64, ) -> Result<Deleted, Error>

Removes a runner from the repository.

async fn job(&self, repository: &str, id: u64) -> Result<JobDetails, Error>

One job’s progress and steps.

async fn run_trigger( &self, repository: &str, run: u64, ) -> Result<RunTrigger, Error>

What started a workflow run.

async fn pull_request( &self, repository: &str, number: u64, ) -> Result<PullRequest, Error>

One pull request: who opened it and where its head branch is.

async fn default_branch(&self, repository: &str) -> Result<String, Error>

The repository’s default branch.

async fn on_branch( &self, repository: &str, branch: &str, sha: &str, ) -> Result<bool, Error>

Whether branch of the repository has the commit sha: its head or an ancestor of it. A tag of the same name, which git would take for it, does not count.

async fn cancel_run(&self, repository: &str, run: u64) -> Result<(), Error>

Cancels a workflow run, and so every job in it: GitHub cancels runs, not single jobs. A run that already completed is left as it is.