Skip to main content

Client

Struct Client 

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

Blocking GitHub REST client.

Implementations§

Source§

impl Client

Source

pub fn new(base_url: &str, token: &str) -> Result<Self, Box<dyn Error>>

Build a client for base_url (typically https://api.github.com, or a GHES instance’s /api/v3 endpoint) authenticated with the given personal access token.

Source

pub fn user_by_username( &self, username: &str, ) -> Result<Option<User>, Box<dyn Error>>

Resolve a username to its full user object. Returns None when the API responds with 404 (no such user); other errors are returned as Err.

Source

pub fn search_pull_requests( &self, query: &str, ) -> Result<Vec<PullRequest>, Box<dyn Error>>

Run the Search Issues endpoint with the caller-supplied query string and return every PR across all result pages.

GitHub caps Search results at 1000 items total; if a query exceeds that, the caller needs to narrow it (e.g. by splitting the date window).

Source

pub fn user_events(&self, username: &str) -> Result<Vec<Event>, Box<dyn Error>>

Paginate through the user-events endpoint up to GitHub’s 300-event cap. Returns the most recent events first.

Source

pub fn count_authored_commits( &self, owner: &str, repo: &str, author: &str, since: NaiveDate, until: NaiveDate, ) -> Result<u64, Box<dyn Error>>

Count commits in owner/repo authored by author within [since, until] (inclusive). Used as a cross-check against push-event counts — see the GitLab equivalent for the rationale.

404 and 409 responses are treated as “0 commits” rather than errors. 404 means the repo was deleted or made private between the events scan and this call; 409 means the repo exists but is empty. Either way, a single missing repo shouldn’t abort the surrounding report. The trade-off: real auth failures targeting a single repo would also be hidden, but GitHub returns 401/403 for those, not 404/409.

Source

pub fn list_tag_refs( &self, owner: &str, repo: &str, ) -> Result<Vec<GitTagRef>, Box<dyn Error>>

List all tag refs for owner/repo. Returns an empty list on 404 (gone repo) and 409 (empty repo) so callers can iterate over many repos without per-repo error handling.

Source

pub fn get_annotated_tag( &self, owner: &str, repo: &str, sha: &str, ) -> Result<AnnotatedTag, Box<dyn Error>>

Fetch one annotated-tag object by SHA. Use only when the matching GitTagRef.object.object_type == "tag" — lightweight tags (where object_type == "commit") have no addressable tag object and this endpoint will 404.

Auto Trait Implementations§

Blanket Implementations§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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