Trait git_cliff_core::remote::RemoteClient

pub trait RemoteClient {
    // Required methods
    fn api_url() -> String;
    fn remote(&self) -> Remote;
    fn client(&self) -> ClientWithMiddleware;

    // Provided methods
    fn early_exit<T: DeserializeOwned + RemoteEntry>(&self, page: &T) -> bool { ... }
    async fn get_entry<T: DeserializeOwned + RemoteEntry>(
        &self,
        project_id: i64,
        page: i32
    ) -> Result<T> { ... }
    async fn get_entries_with_page<T: DeserializeOwned + RemoteEntry>(
        &self,
        project_id: i64,
        page: i32
    ) -> Result<Vec<T>> { ... }
    async fn fetch<T: DeserializeOwned + RemoteEntry>(
        &self,
        project_id: i64
    ) -> Result<Vec<T>> { ... }
    async fn fetch_with_early_exit<T: DeserializeOwned + RemoteEntry>(
        &self,
        project_id: i64
    ) -> Result<Vec<T>> { ... }
}

Available on crate features github or gitlab or bitbucket only.

Trait for handling the API connection and fetching.

Required Methods

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.

Provided Methods

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.

See fetch_with_early_exit for the early exit version of this method.

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.

Early exits based on the response.

Object Safety

This trait is not object safe.

Implementors

impl RemoteClient for BitbucketClient

Available on crate feature bitbucket only.

impl RemoteClient for GitHubClient

Available on crate feature github only.

impl RemoteClient for GitLabClient

Available on crate feature gitlab only.