pub struct CollabClient { /* private fields */ }Expand description
Collaboration client
Implementations§
Source§impl CollabClient
impl CollabClient
Sourcepub async fn connect(config: ClientConfig) -> Result<Self>
pub async fn connect(config: ClientConfig) -> Result<Self>
Create a new client and connect to server
Sourcepub async fn on_workspace_update<F>(&self, callback: F)
pub async fn on_workspace_update<F>(&self, callback: F)
Sourcepub async fn on_state_change<F>(&self, callback: F)
pub async fn on_state_change<F>(&self, callback: F)
Subscribe to connection state changes
§Arguments
callback- Function to call when connection state changes
Sourcepub async fn subscribe_to_workspace(&self, workspace_id: &str) -> Result<()>
pub async fn subscribe_to_workspace(&self, workspace_id: &str) -> Result<()>
Subscribe to a workspace
Sourcepub async fn unsubscribe_from_workspace(&self, workspace_id: &str) -> Result<()>
pub async fn unsubscribe_from_workspace(&self, workspace_id: &str) -> Result<()>
Unsubscribe from a workspace
Sourcepub async fn request_state(
&self,
workspace_id: &str,
version: i64,
) -> Result<()>
pub async fn request_state( &self, workspace_id: &str, version: i64, ) -> Result<()>
Request state for a workspace
Sourcepub async fn state(&self) -> ConnectionState
pub async fn state(&self) -> ConnectionState
Get connection state
Sourcepub async fn queued_message_count(&self) -> usize
pub async fn queued_message_count(&self) -> usize
Get queued message count
Sourcepub async fn reconnect_count(&self) -> u32
pub async fn reconnect_count(&self) -> u32
Get reconnect attempt count
Sourcepub async fn disconnect(&self) -> Result<()>
pub async fn disconnect(&self) -> Result<()>
Disconnect from server
Trait Implementations§
Auto Trait Implementations§
impl Freeze for CollabClient
impl !RefUnwindSafe for CollabClient
impl Send for CollabClient
impl Sync for CollabClient
impl Unpin for CollabClient
impl !UnwindSafe for CollabClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more