Struct CurrentAuthHandler

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

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

impl<'octo> CurrentAuthHandler<'octo>

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

Fetches information about the current user.

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

Fetches information about the currently authenticated app.

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

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

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

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

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?;

2. 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

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

List gists that were starred by the authenticated user.

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

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