Trait RemoteClient 

pub trait RemoteClient {
    const API_URL: &'static str;
    const API_URL_ENV: &'static str;

    // Required methods
    fn remote(&self) -> Remote;
    fn client(&self) -> ClientWithMiddleware;

    // Provided methods
    fn api_url(&self) -> String { ... }
    async fn get_json<T: DeserializeOwned>(&self, url: &str) -> Result<T> { ... }
}

Available on crate feature remote only.

Trait for handling the API connection and fetching.

Required Associated Constants

const API_URL: &'static str

API URL for a particular client

const API_URL_ENV: &'static str

Name of the environment variable used to set the API URL to a self-hosted instance (if applicable).

Required Methods

fn remote(&self) -> Remote

Returns the remote repository information.

fn client(&self) -> ClientWithMiddleware

Returns the HTTP client for making requests.

Provided Methods

fn api_url(&self) -> String

Returns the API url.

async fn get_json<T: DeserializeOwned>(&self, url: &str) -> Result<T>

Performs a HTTP GET request, deserializes the JSON response, and returns the result. This is the core HTTP request and JSON parsing logic shared by all API methods. Callers are responsible for any additional processing of the deserialized data.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl RemoteClient for AzureDevOpsClient

Available on crate feature azure_devops only.

const API_URL: &'static str = "https://dev.azure.com"

const API_URL_ENV: &'static str = "AZURE_DEVOPS_API_URL"

impl RemoteClient for BitbucketClient

Available on crate feature bitbucket only.

const API_URL: &'static str = "https://api.bitbucket.org/2.0/repositories"

const API_URL_ENV: &'static str = "BITBUCKET_API_URL"

impl RemoteClient for GiteaClient

Available on crate feature gitea only.

const API_URL: &'static str = "https://codeberg.org"

const API_URL_ENV: &'static str = "GITEA_API_URL"

impl RemoteClient for GitHubClient

Available on crate feature github only.

const API_URL: &'static str = "https://api.github.com"

const API_URL_ENV: &'static str = "GITHUB_API_URL"

impl RemoteClient for GitLabClient

Available on crate feature gitlab only.

const API_URL: &'static str = "https://gitlab.com/api/v4"

const API_URL_ENV: &'static str = "GITLAB_API_URL"