Skip to main content

GitHubClient

Struct GitHubClient 

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

GitHub API client using todoku’s HttpClient.

Implementations§

Source§

impl GitHubClient

Source

pub fn new(token: Option<&str>) -> Result<Self, TodokuError>

Create a new GitHub client with optional token.

§Errors

Returns TodokuError if the underlying HTTP client fails to build.

Source

pub fn from_client(client: HttpClient) -> Self

Create from an existing HttpClient (for custom configuration).

Source

pub fn from_env() -> Result<Self, TodokuError>

Create from the GITHUB_TOKEN environment variable.

§Errors

Returns TodokuError if the underlying HTTP client fails to build.

Trait Implementations§

Source§

impl GitHubApi for GitHubClient

Source§

fn get_repo_head<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, owner: &'life1 str, repo: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<String, TodokuError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get the HEAD commit SHA for a repo’s default branch.
Source§

fn get_latest_tag<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, owner: &'life1 str, repo: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, TodokuError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get the latest tag for a repo (returns None if no tags).
Source§

fn get_primary_language<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, owner: &'life1 str, repo: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, TodokuError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Detect the primary language of a repo.
Source§

fn list_repos<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 str, owner_type: OwnerType, ) -> Pin<Box<dyn Future<Output = Result<Vec<GitHubRepo>, TodokuError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List repos for an org or user.
Source§

fn get_file_info<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, owner: &'life1 str, repo: &'life2 str, path: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<FileInfo, TodokuError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Get file metadata (SHA, size, download URL).

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

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