pub struct CurrentAuthHandler<'octo> { /* private fields */ }
Expand description

Handler for the current authenication API. Note All of the methods provided below require at least some authenication such as personal token in order to be used.

Created with Octocrab::current.

Implementations§

source§

impl<'octo> CurrentAuthHandler<'octo>

source

pub async fn user(&self) -> Result<Author>

Fetches information about the current user.

source

pub async fn app(&self) -> Result<App>

Fetches information about the currently authenticated app.


let app = octocrab
    .current()
    .app()
    .await?;

println!("{}", app.name);
source

pub fn list_repos_starred_by_authenticated_user( &self ) -> ListStarredReposBuilder<'octo>

List repositories starred by current authenticated user.

octocrab::instance()
    .current()
    .list_repos_starred_by_authenticated_user()
    .send()
    .await?;

See the GitHub API documentation

source

pub fn list_repos_for_authenticated_user( &self ) -> ListReposForAuthenticatedUserBuilder<'octo>

Lists repositories that the current authenticated user.

octocrab::instance()
    .current()
    .list_repos_for_authenticated_user()
    .send()
    .await?;

See the GitHub API documentation

source

pub fn list_gists_for_authenticated_user( &self ) -> ListGistsForAuthenticatedUserBuilder<'octo>

List gists for the current authenticated user.

§Examples
  1. The following snippet retrieves the most recent gist:
octocrab::instance()
    .current()
    .list_gists_for_authenticated_user()
    .per_page(1)
    .page(1)
    .send()
    .await?;
  1. This retrieves the first 100 gists, which is maximum number that can be fetched in a single page:
octocrab::instance()
    .current()
    .list_gists_for_authenticated_user()
    .per_page(100)
    .page(1)
    .send()
    .await?;

See the GitHub API documentation

source

pub fn list_gists_starred_by_authenticated_user( &self ) -> ListStarredGistsBuilder<'octo>

List gists that were starred by the authenticated user.

source

pub fn list_app_installations_accessible_to_user( &self ) -> ListAppInstallationsAccessibleToUserBuilder<'octo>

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

octocrab::instance()
    .current()
    .list_app_installations_accessible_to_user()
    .send()
    .await?;

See the GitHub API documentation

source

pub fn list_org_memberships_for_authenticated_user( &self ) -> ListOrgMembershipsForAuthenticatedUserBuilder<'octo>

Lists organizations that the current authenticated user is a member of.

octocrab::instance()
    .current()
    .list_org_memberships_for_authenticated_user()
    .send()
    .await?;

See the GitHub API documentation

Auto Trait Implementations§

§

impl<'octo> Freeze for CurrentAuthHandler<'octo>

§

impl<'octo> !RefUnwindSafe for CurrentAuthHandler<'octo>

§

impl<'octo> Send for CurrentAuthHandler<'octo>

§

impl<'octo> Sync for CurrentAuthHandler<'octo>

§

impl<'octo> Unpin for CurrentAuthHandler<'octo>

§

impl<'octo> !UnwindSafe for CurrentAuthHandler<'octo>

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: 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: 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>,

§

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>,

§

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