Trait Provider

pub trait Provider {
    type Project: DeserializeOwned + Project;
    type Error: DeserializeOwned + JsonError;

    // Required methods
    fn new(
        filter: Filter,
        secret_token: AuthToken,
        api_url_override: Option<Url>,
    ) -> Result<Self, Error>
       where Self: Sized;
    fn filter(&self) -> &Filter;
    fn secret_token(&self) -> &AuthToken;
    fn auth_header_key() -> &'static str;
    fn get_user_projects(
        &self,
        user: &User,
    ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>;
    fn get_group_projects(
        &self,
        group: &Group,
    ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>;
    fn get_accessible_projects(
        &self,
    ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>;
    fn get_current_user(&self) -> Result<User, ApiError<Self::Error>>;

    // Provided methods
    fn get_own_projects(
        &self,
    ) -> Result<Vec<Self::Project>, ApiError<Self::Error>> { ... }
    fn call_list(
        &self,
        uri: &Url,
        accept_header: Option<&str>,
    ) -> Result<Vec<Self::Project>, ApiError<Self::Error>> { ... }
    fn get_repos(
        &self,
        worktree_setup: bool,
        force_ssh: bool,
        remote_name: Option<RemoteName>,
    ) -> Result<HashMap<Option<ProjectNamespace>, Vec<Repo>>, Error> { ... }
}

Required Associated Types

type Project: DeserializeOwned + Project

type Error: DeserializeOwned + JsonError

Required Methods

fn new( filter: Filter, secret_token: AuthToken, api_url_override: Option<Url>, ) -> Result<Self, Error>

where Self: Sized,

fn filter(&self) -> &Filter

fn secret_token(&self) -> &AuthToken

fn auth_header_key() -> &'static str

fn get_user_projects( &self, user: &User, ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>

fn get_group_projects( &self, group: &Group, ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>

fn get_accessible_projects( &self, ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>

fn get_current_user(&self) -> Result<User, ApiError<Self::Error>>

Provided Methods

fn get_own_projects(&self) -> Result<Vec<Self::Project>, ApiError<Self::Error>>

fn call_list( &self, uri: &Url, accept_header: Option<&str>, ) -> Result<Vec<Self::Project>, ApiError<Self::Error>>

Calls the API at specific uri and expects a successful response of Vec<T> back, or an error response U

Handles paging with “link” HTTP headers properly and reads all pages to the end.

fn get_repos( &self, worktree_setup: bool, force_ssh: bool, remote_name: Option<RemoteName>, ) -> Result<HashMap<Option<ProjectNamespace>, Vec<Repo>>, Error>

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 Provider for Github

type Error = GithubApiErrorResponse

type Project = GithubProject

impl Provider for Gitlab

type Error = GitlabApiErrorResponse

type Project = GitlabProject