Struct git_cliff_core::remote::github::GitHubClient

pub struct GitHubClient { /* private fields */ }

Available on (crate features github or gitlab or bitbucket) and crate feature github only.

HTTP client for handling GitHub REST API requests.

Implementations

impl GitHubClient

pub async fn get_commits(&self) -> Result<Vec<Box<dyn RemoteCommit>>>

Fetches the GitHub API and returns the commits.

pub async fn get_pull_requests(&self) -> Result<Vec<Box<dyn RemotePullRequest>>>

Fetches the GitHub API and returns the pull requests.

Trait Implementations

impl Clone for GitHubClient

fn clone(&self) -> GitHubClient

Returns a copy 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.

impl RemoteClient for GitHubClient

fn api_url() -> String

Returns the API url.

fn remote(&self) -> Remote

Returns the remote repository information.

fn client(&self) -> ClientWithMiddleware

Returns the HTTP client for making requests.

fn early_exit<T: DeserializeOwned + RemoteEntry>(&self, page: &T) -> bool

Returns true if the client should early exit.

async fn get_entry<T: DeserializeOwned + RemoteEntry>( &self, project_id: i64, page: i32 ) -> Result<T>

Retrieves a single object.

async fn get_entries_with_page<T: DeserializeOwned + RemoteEntry>( &self, project_id: i64, page: i32 ) -> Result<Vec<T>>

Retrieves a single page of entries.

async fn fetch<T: DeserializeOwned + RemoteEntry>( &self, project_id: i64 ) -> Result<Vec<T>>

Fetches the remote API and returns the given entry.

async fn fetch_with_early_exit<T: DeserializeOwned + RemoteEntry>( &self, project_id: i64 ) -> Result<Vec<T>>

Fetches the remote API and returns the given entry.

impl TryFrom<Remote> for GitHubClient

Constructs a GitHub client from the remote configuration.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(remote: Remote) -> Result<Self>

Performs the conversion.