Skip to main content

Github

Struct Github 

Source
pub struct Github { /* private fields */ }
Expand description

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§

Source§

impl Github

Source

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.

Source

pub fn requests(&self) -> Report

What the requests of this client counted since its last line was logged, and the rate limit as last read.

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§

Source§

impl Debug for Github

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Github

Source§

fn drop(&mut self)

The last window’s line, as the daemon stops.

Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl GithubApi for Github

Source§

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.
Source§

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

The repository’s self-hosted runners.
Source§

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 the runner’s listener takes.
Source§

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

Removes a runner from the repository.
Source§

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

One job’s progress and steps.
Source§

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

What started a workflow run.
Source§

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

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

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

The repository’s default branch and visibility.
Source§

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.
Source§

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.
Source§

async fn job_action( &self, repository: &str, request: JobActionRequest, permit: &Permit<'_>, ) -> Result<u16, ActionFailure>

Sends an owner’s job action once, and returns GitHub’s success status (201, 202, …) without reading its body, which is an acknowledgement, not a new job. It is never sent again but after a 401, which GitHub answers before it acts. permit is asked once the token is in hand, before each send, the 401’s second included: when it says no, nothing is sent and the answer is ActionFailure::Withdrawn.
Source§

async fn action_run( &self, repository: &str, run: u64, ) -> Result<RunNow, ActionFailure>

Reads a workflow run’s current attempt and whether it completed, for a job action; failures as a class and a status.
Source§

async fn attempt_jobs( &self, repository: &str, run: u64, attempt: u32, ) -> Result<Vec<AttemptJob>, ActionFailure>

The jobs of attempt attempt of a workflow run, every runner’s, with their conclusions, for a re-run of a run its runner failed (ADR 0153); failures as a class and a status.
Source§

async fn named_runs(&self) -> Vec<NamedRun>

The workflows’ names of the runs whose job reads kept GitHub’s name because the workflow’s could not be read then, as far as they can be read now (ADR 0140). Each run is given once; one whose workflow GitHub does not give is dropped, and keeps GitHub’s name.
Source§

fn spend(&self) -> Spend

What the reads are paced by (ADR 0127): the rate limit as last read, and the registrations and deletes sent.
Source§

impl Source for Github

Source§

async fn action_repository( &self, repository: &str, ) -> Result<ActionRepository, Error>

A repository’s canonical name, visibility and default branch.
Source§

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

The commit branch of repository is at.
Source§

async fn tree(&self, repository: &str, commit: &str) -> Result<Tree, Error>

The repository’s tree at commit, every file of it.
Source§

async fn blob( &self, repository: &str, blob: &str, limit: u64, ) -> Result<Vec<u8>, Error>

A file’s bytes by its blob’s SHA, at most limit of them.
Source§

async fn tarball( &self, repository: &str, commit: &str, to: &Path, limit: u64, received: &AtomicU64, ) -> Result<u64, Error>

Downloads the archive of repository at commit anonymously (codeload.github.com’s /{owner}/{repo}/tar.gz/ {sha}) into the new file to, at most limit bytes, and returns its size. Never with a token: a repository that is not public is not there. Adds every byte of the body it receives to received, the one past limit and a failed download’s included.
Source§

fn spare_requests(&self) -> Option<u64>

The requests left of GitHub’s rate limit before it resets, as last read; None when no answer said.

Auto Trait Implementations§

§

impl !Freeze for Github

§

impl !RefUnwindSafe for Github

§

impl !UnwindSafe for Github

§

impl Forget for Github

§

impl Move for Github

§

impl Send for Github

§

impl Sync for Github

§

impl Unpin for Github

§

impl UnsafeUnpin for Github

Blanket Implementations§

Source§

impl<G> ActionsGithub for G
where G: GithubApi + 'static,

Source§

fn run<'call>( &'call self, repository: &'call str, run: u64, ) -> Pin<Box<dyn Future<Output = Result<RunNow, ActionFailure>> + Send + 'call>>

Reads the run’s current attempt and whether it completed.
Source§

fn attempt_jobs<'call>( &'call self, repository: &'call str, run: u64, attempt: u32, ) -> Pin<Box<dyn Future<Output = Result<Vec<AttemptJob>, ActionFailure>> + Send + 'call>>

Reads the jobs of attempt attempt of the run, every runner’s, with their conclusions.
Source§

fn send<'call>( &'call self, repository: &'call str, request: JobActionRequest, permit: &'call (dyn Fn() -> Pin<Box<dyn Future<Output = bool> + Send + 'call>> + Send + Sync), ) -> Pin<Box<dyn Future<Output = Result<u16, ActionFailure>> + Send + 'call>>

Sends request once, asking permit once the token is in hand and before each send; GitHub’s success status, or why not.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more