Struct Connection 

pub struct Connection<Sink, Stream> { /* private fields */ }

Connection handler over a pair of message streams, which implements a Yjs/Yrs awareness and update exchange protocol.

This connection implements Future pattern and can be awaited upon in order for a caller to recognize whether underlying websocket connection has been finished gracefully or abruptly.

Implementations

impl<Sink, Stream, E> Connection<Sink, Stream>

where Sink: SinkExt<Vec<u8>, Error = E> + Send + Sync + Unpin + 'static, E: Into<Error> + Send + Sync,

pub async fn send(&self, msg: Vec<u8>) -> Result<(), Error>

pub async fn close(self) -> Result<(), E>

pub fn sink(&self) -> Weak<Mutex<Sink>>

impl<Sink, Stream, E> Connection<Sink, Stream>

where Stream: StreamExt<Item = Result<Vec<u8>, E>> + Send + Sync + Unpin + 'static, Sink: SinkExt<Vec<u8>, Error = E> + Send + Sync + Unpin + 'static, E: Into<Error> + Send + Sync,

pub fn new( awareness: Arc<RwLock<Awareness>>, sink: Sink, stream: Stream, ) -> Self

Wraps incoming [WebSocket] connection and supplied Awareness accessor into a new connection handler capable of exchanging Yrs/Yjs messages.

While creation of new [AxumConn] always succeeds, a connection itself can possibly fail while processing incoming input/output. This can be detected by awaiting for returned [AxumConn] and handling the awaited result.

pub fn awareness(&self) -> &Arc<RwLock<Awareness>>

Returns an underlying Awareness structure, that contains client state of that connection.

pub fn with_protocol<P>( awareness: Arc<RwLock<Awareness>>, sink: Sink, stream: Stream, protocol: P, ) -> Self

where P: Protocol + Send + Sync + 'static,

Wraps incoming [WebSocket] connection and supplied Awareness accessor into a new connection handler capable of exchanging Yrs/Yjs messages.

While creation of new [AxumConn] always succeeds, a connection itself can possibly fail while processing incoming input/output. This can be detected by awaiting for returned [AxumConn] and handling the awaited result.

Trait Implementations

impl<Sink: Debug, Stream: Debug> Debug for Connection<Sink, Stream>

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

Formats the value using the given formatter.

impl<Sink, Stream> Future for Connection<Sink, Stream>

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<Sink, Stream> Unpin for Connection<Sink, Stream>