Struct GitHubClient

pub struct GitHubClient { /* private fields */ }

Client for GitHub’s REST API

The GitHub client can be used to send HTTP requests to GitHub’s REST API. The client handles authentication, serialization, and pagination.

Implementations

impl GitHubClient

pub fn new( github_host: GitHubHost, app_id: AppId, private_key: PrivateKey, installation_id: InstallationId, ) -> Self

Initializes a new instance of the GitHub client

pub async fn get<T>(&self, endpoint: &str) -> Result<T, Error>

where T: DeserializeOwned,

Send a GET request to GitHub

pub async fn post<T>( &self, endpoint: &str, body: Option<impl Serialize>, ) -> Result<T, Error>

where T: DeserializeOwned,

Send a POST request to GitHub

pub async fn patch<T>( &self, endpoint: &str, body: Option<impl Serialize>, ) -> Result<T, Error>

where T: DeserializeOwned,

Send a PATCH request to GitHub

pub async fn paginate<T>( &self, method: Method, endpoint: &str, key: &str, ) -> Result<Vec<T>, Error>

where T: DeserializeOwned,

Send a paginated request to GitHub

Trait Implementations

impl Clone for GitHubClient

fn clone(&self) -> GitHubClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitHubClient

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

Formats the value using the given formatter.