Struct Client

pub struct Client(/* private fields */);

A codemp client handle.

It generates a new UUID and stores user credentials upon connecting.

A new Client can be obtained with Client::connect.

Implementations

impl Client

pub async fn connect(config: Config) -> ConnectionResult<Self>

Connect to the server, authenticate and instantiate a new Client.

pub async fn refresh(&self) -> RemoteResult<()>

Refresh session token.

pub async fn create_workspace(&self, name: impl AsRef<str>) -> RemoteResult<()>

Attempt to create a new workspace with given name.

pub async fn delete_workspace(&self, name: impl AsRef<str>) -> RemoteResult<()>

Delete an existing workspace if possible.

pub async fn invite_to_workspace( &self, workspace_name: impl AsRef<str>, user_name: impl AsRef<str>, ) -> RemoteResult<()>

Invite user with given username to the given workspace, if possible.

pub async fn fetch_owned_workspaces(&self) -> RemoteResult<Vec<String>>

Fetch the names of all workspaces owned by the current user.

pub async fn fetch_joined_workspaces(&self) -> RemoteResult<Vec<String>>

Fetch the names of all workspaces the current user has joined.

pub async fn attach_workspace( &self, workspace: impl AsRef<str>, ) -> ConnectionResult<Workspace>

Join and return a Workspace.

pub fn leave_workspace(&self, id: &str) -> bool

Leave the Workspace with the given name.

pub fn get_workspace(&self, id: &str) -> Option<Workspace>

Gets a Workspace handle by name.

pub fn active_workspaces(&self) -> Vec<String>

Get the names of all active Workspaces.

pub fn current_user(&self) -> &User

Get the currently logged in user.

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 Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.