Struct Workspace

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

A currently active shared development environment

Workspaces encapsulate a working environment: cursor positions, filetree, user list and more. Each holds a cursor::Controller and a map of buffer::Controllers. Using a workspace handle, it’s possible to receive events (user join/leave, filetree updates) and create/delete/attach to new buffers.

Implementations

impl Workspace

pub async fn create_buffer(&self, path: &str) -> RemoteResult<()>

Create a new buffer in the current workspace.

pub async fn attach_buffer(&self, path: &str) -> ConnectionResult<Controller>

Attach to a buffer and return a handle to it.

pub fn detach_buffer(&self, path: &str) -> bool

Detach from an active buffer.

This will stop and drop its buffer::Controller.

Returns true if it was connectly dropped or wasn’t present, false if it was dropped but wasn’t the last existing reference to it. If this method returns false it means you have a dangling reference somewhere. It may just be waiting for garbage collection, but as long as it exists, it will prevent the controller from being completely dropped.

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

Re-fetch the list of available buffers in the workspace.

pub async fn fetch_users(&self) -> RemoteResult<Vec<User>>

Re-fetch the list of all users in the workspace.

pub async fn fetch_buffer_users(&self, path: &str) -> RemoteResult<Vec<User>>

Fetch a list of the Users attached to a specific buffer.

pub async fn delete_buffer(&self, path: &str) -> RemoteResult<()>

Delete a buffer.

pub fn id(&self) -> String

Get the workspace unique id.

pub fn cursor(&self) -> Controller

Return a handle to the cursor::Controller.

pub fn get_buffer(&self, path: &str) -> Option<Controller>

Return a handle to the buffer::Controller with the given path, if present.

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

Get a list of all the currently attached buffers.

pub fn user_list(&self) -> Vec<User>

Get all names of users currently in this workspace

pub fn search_buffers(&self, filter: Option<&str>) -> Vec<String>

Get the filetree as it is currently cached. A filter may be applied, and it may be strict (equality check) or not (starts_with check).

Trait Implementations

impl AsyncReceiver<Event> for Workspace

async fn try_recv(&self) -> ControllerResult<Option<Event>>

Attempt to receive a value, return None if nothing is currently available.

async fn poll(&self) -> ControllerResult<()>

Block until a value is available, without consuming it.

fn clear_callback(&self)

Clear the currently registered callback.

fn callback(&self, cb: impl Into<ControllerCallback<Self>>)

Register a callback to be called on receive.

async fn recv(&self) -> ControllerResult<T>

Block until a value is available and returns it.

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.