Github

Struct Github 

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

Entry point interface for interacting with GitHub API

Implementations§

Source§

impl Github

Source

pub fn new<A, C>(agent: A, credentials: C) -> Result<Self>
where A: Into<String>, C: Into<Option<Credentials>>,

Source

pub fn host<H, A, C>(host: H, agent: A, credentials: C) -> Result<Self>
where H: Into<String>, A: Into<String>, C: Into<Option<Credentials>>,

Source

pub fn custom<H, A, CR>( host: H, agent: A, credentials: CR, http: Client, ) -> Self
where H: Into<String>, A: Into<String>, CR: Into<Option<Credentials>>,

Source

pub fn set_credentials<CR>(&mut self, credentials: CR)
where CR: Into<Option<Credentials>>,

Source

pub fn rate_limit(&self) -> RateLimit

Source

pub fn activity(&self) -> Activity

Return a reference to user activity

Source

pub fn repo<O, R>(&self, owner: O, repo: R) -> Repository
where O: Into<String>, R: Into<String>,

Return a reference to a Github repository

Source

pub fn user_repos<S>(&self, owner: S) -> UserRepositories
where S: Into<String>,

Return a reference to the collection of repositories owned by and associated with an owner

Source

pub fn repos(&self) -> Repositories

Return a reference to the collection of repositories owned by the user associated with the current authentication credentials

Source

pub fn org<O>(&self, org: O) -> Organization
where O: Into<String>,

Source

pub fn orgs(&self) -> Organizations

Return a reference to the collection of organizations that the user associated with the current authentication credentials is in

Source

pub fn users(&self) -> Users

Return a reference to an interface that provides access to user information.

Source

pub fn user_orgs<U>(&self, user: U) -> UserOrganizations
where U: Into<String>,

Return a reference to the collection of organizations a user is publicly associated with

Source

pub fn user_gists<O>(&self, owner: O) -> UserGists
where O: Into<String>,

Return a reference to an interface that provides access to a user’s gists

Source

pub fn gists(&self) -> Gists

Return a reference to an interface that provides access to the gists belonging to the owner of the token used to configure this client

Source

pub fn search(&self) -> Search

Return a reference to an interface that provides access to search operations

Source

pub fn org_repos<O>(&self, org: O) -> OrganizationRepositories
where O: Into<String>,

Return a reference to the collection of repositories owned by and associated with an organization

Source

pub fn app(&self) -> App

Return a reference to GitHub Apps

Trait Implementations§

Source§

impl Clone for Github

Source§

fn clone(&self) -> Github

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Github

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Github

§

impl !RefUnwindSafe for Github

§

impl Send for Github

§

impl Sync for Github

§

impl Unpin for Github

§

impl !UnwindSafe for Github

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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