Struct Workspace

Source
pub struct Workspace(/* private fields */);
Expand description

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§

Source§

impl Workspace

Source

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

Create a new buffer in the current workspace.

Source

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

Attach to a buffer and return a handle to it.

Source

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.

Source

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

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

Source

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

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

Source

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

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

Source

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

Delete a buffer.

Source

pub fn id(&self) -> String

Get the workspace unique id.

Source

pub fn cursor(&self) -> Controller

Return a handle to the cursor::Controller.

Source

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

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

Source

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

Get a list of all the currently attached buffers.

Source

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

Get all names of users currently in this workspace

Source

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§

Source§

impl AsyncReceiver<Event> for Workspace

Source§

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

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

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

Block until a value is available, without consuming it.
Source§

fn clear_callback(&self)

Clear the currently registered callback.
Source§

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

Register a callback to be called on receive. Read more
Source§

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

Block until a value is available and returns it.
Source§

impl Clone for Workspace

Source§

fn clone(&self) -> Workspace

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Workspace

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more