Struct Octocrab

pub struct Octocrab {
    pub base_url: Url,
    /* private fields */
}

The GitHub API client.

Fields

base_url: Url

Implementations

impl Octocrab

Constructors

pub fn builder() -> OctocrabBuilder

Returns a new OctocrabBuilder.

pub fn installation(&self, id: InstallationId) -> Octocrab

Returns a new Octocrab based on the current builder but authorizing via a specific installation ID. Typically you will first construct an Octocrab using OctocrabBuilder::app to authenticate as your Github App, then obtain an installation ID, and then pass that here to obtain a new Octocrab with which you can make API calls with the permissions of that installation.

impl Octocrab

GitHub API Methods

pub fn actions(&self) -> ActionsHandler<'_>

Creates a new actions::ActionsHandler for accessing information from GitHub Actions.

pub fn current(&self) -> CurrentAuthHandler<'_>

Creates a current::CurrentAuthHandler that allows you to access information about the current authenticated user.

pub fn activity(&self) -> ActivityHandler<'_>

Creates a activity::ActivityHandler for the current authenticated user.

pub fn apps(&self) -> AppsRequestHandler<'_>

Creates a new apps::AppsRequestHandler for the currently authenticated app.

pub fn gitignore(&self) -> GitignoreHandler<'_>

Creates a gitignore::GitignoreHandler for accessing information about gitignore.

pub fn issues( &self, owner: impl Into<String>, repo: impl Into<String>, ) -> IssueHandler<'_>

Creates a issues::IssueHandler for the repo specified at owner/repo, that allows you to access GitHub’s issues API.

pub fn licenses(&self) -> LicenseHandler<'_>

Creates a licenses::LicenseHandler.

pub fn markdown(&self) -> MarkdownHandler<'_>

Creates a markdown::MarkdownHandler.

pub fn orgs(&self, owner: impl Into<String>) -> OrgHandler<'_>

Creates an orgs::OrgHandler for the specified organization, that allows you to access GitHub’s organization API.

pub fn pulls( &self, owner: impl Into<String>, repo: impl Into<String>, ) -> PullRequestHandler<'_>

Creates a pulls::PullRequestHandler for the repo specified at owner/repo, that allows you to access GitHub’s pull request API.

pub fn repos( &self, owner: impl Into<String>, repo: impl Into<String>, ) -> RepoHandler<'_>

Creates a repos::RepoHandler for the repo specified at owner/repo, that allows you to access GitHub’s repository API.

pub fn search(&self) -> SearchHandler<'_>

Creates a search::SearchHandler that allows you to construct general queries to GitHub’s API.

pub fn teams(&self, owner: impl Into<String>) -> TeamHandler<'_>

Creates a teams::TeamHandler for the specified organization that allows you to access GitHub’s teams API.

pub fn workflows( &self, owner: impl Into<String>, repo: impl Into<String>, ) -> WorkflowsHandler<'_>

Creates a workflows::WorkflowsHandler for the specified repository that allows you to access GitHub’s workflows API.

pub fn events(&self) -> EventsBuilder<'_>

Creates an events::EventsBuilder that allows you to access GitHub’s events API.

pub fn gists(&self) -> GistsHandler<'_>

Creates a gists::GistsHandler that allows you to access GitHub’s Gists API.

pub fn ratelimit(&self) -> RateLimitHandler<'_>

Creates a ratelimit::RateLimitHandler that returns the API rate limit.

impl Octocrab

GraphQL API.

pub async fn graphql<R: FromResponse>( &self, body: &(impl Serialize + ?Sized), ) -> Result<R>

Sends a graphql query to GitHub, and deserialises the response from JSON.

let response: serde_json::Value = octocrab::instance()
    .graphql("query { viewer { login }}")
    .await?;

impl Octocrab

HTTP Methods

A collection of different of HTTP methods to use with Octocrab’s configuration (Authenication, etc.). All of the HTTP methods (get, post, etc.) perform some amount of pre-processing such as making relative urls absolute, and post processing such as mapping any potential GitHub errors into Err() variants, and deserializing the response body.

This isn’t always ideal when working with GitHub’s API and as such there are additional methods available prefixed with _ (e.g. _get, _post, etc.) that perform no pre or post processing and directly return the reqwest::Response struct.

pub async fn post<P: Serialize + ?Sized, R: FromResponse>( &self, route: impl AsRef<str>, body: Option<&P>, ) -> Result<R>

Send a POST request to route with an optional body, returning the body of the response.

pub async fn _post<P: Serialize + ?Sized>( &self, url: impl IntoUrl, body: Option<&P>, ) -> Result<Response>

Send a POST request with no additional pre/post-processing.

pub async fn get<R, A, P>(&self, route: A, parameters: Option<&P>) -> Result<R>

where A: AsRef<str>, P: Serialize + ?Sized, R: FromResponse,

Send a GET request to route with optional query parameters, returning the body of the response.

pub async fn _get<P: Serialize + ?Sized>( &self, url: impl IntoUrl, parameters: Option<&P>, ) -> Result<Response>

Send a GET request with no additional post-processing.

pub async fn patch<R, A, B>(&self, route: A, body: Option<&B>) -> Result<R>

where A: AsRef<str>, B: Serialize + ?Sized, R: FromResponse,

Send a PATCH request to route with optional query parameters, returning the body of the response.

pub async fn _patch<B: Serialize + ?Sized>( &self, url: impl IntoUrl, parameters: Option<&B>, ) -> Result<Response>

Send a PATCH request with no additional post-processing.

pub async fn put<R, A, B>(&self, route: A, body: Option<&B>) -> Result<R>

where A: AsRef<str>, B: Serialize + ?Sized, R: FromResponse,

Send a PUT request to route with optional query parameters, returning the body of the response.

pub async fn _put<B: Serialize + ?Sized>( &self, url: impl IntoUrl, body: Option<&B>, ) -> Result<Response>

Send a PATCH request with no additional post-processing.

pub async fn delete<R, A, P>( &self, route: A, parameters: Option<&P>, ) -> Result<R>

where A: AsRef<str>, P: Serialize + ?Sized, R: FromResponse,

Send a DELETE request to route with optional query parameters, returning the body of the response.

pub async fn _delete<P: Serialize + ?Sized>( &self, url: impl IntoUrl, parameters: Option<&P>, ) -> Result<Response>

Send a DELETE request with no additional post-processing.

pub fn request_builder( &self, url: impl IntoUrl, method: Method, ) -> RequestBuilder

Construct a reqwest::RequestBuilder with the given http method. This can be executed with execute.

let octocrab = octocrab::instance();
let url = format!("{}/events", octocrab.base_url);
let builder = octocrab::instance().request_builder(&url, reqwest::Method::GET)
    .header("if-none-match", "\"73ca617c70cd2bd9b6f009dab5e2d49d\"");
let response = octocrab.execute(builder).await?;

pub async fn execute(&self, request: RequestBuilder) -> Result<Response>

Execute the given request using octocrab’s Client.

impl Octocrab

Utility Methods

pub fn absolute_url(&self, url: impl AsRef<str>) -> Result<Url>

Returns an absolute url version of url using the base_url (default: https://api.github.com)

pub async fn get_page<R: DeserializeOwned>( &self, url: &Option<Url>, ) -> Result<Option<Page<R>>>

A convenience method to get a page of results (if present).

pub async fn all_pages<R: DeserializeOwned>( &self, page: Page<R>, ) -> Result<Vec<R>>

A convenience method to get all the results starting at a given page.

Trait Implementations

impl Clone for Octocrab

fn clone(&self) -> Octocrab

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Octocrab

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

Formats the value using the given formatter.

impl Default for Octocrab

Defaults for Octocrab:

• base_url: https://api.github.com
• auth: None
• client: reqwest client with the octocrab user agent.

fn default() -> Self

Returns the “default value” for a type.