Struct centraldogma::Client

pub struct Client { /* fields omitted */ }

Root client for top level APIs.
Implements crate::ProjectService

Implementations

impl Client

pub async fn new(base_url: &str, token: Option<&str>) -> Result<Self, Error>

Returns a new client from provided base_url and an optional token string for authentication. Only visible ASCII characters (32-127) are permitted as token.

pub fn project<'a>(&'a self, project_name: &'a str) -> ProjectClient<'a>

Creates a temporary client within a context of the specified Project.

pub fn repo<'a>(
    &'a self,
    project_name: &'a str,
    repo_name: &'a str
) -> RepoClient<'a>

Creates a temporary client within a context of the specified Repository.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ProjectService for Client

fn create_project<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Project, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Creates a project.

fn remove_project<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Removes a project. A removed project can be unremoved.

fn purge_project<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Purges a project that was removed before.

fn unremove_project<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Project, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Unremoves a project.

fn list_projects<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Project>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the list of the projects.

fn list_removed_projects<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the list of the removed projects, which can be unremoved or purged.