Struct siderite::connection::Connection

pub struct Connection { /* fields omitted */ }

A handle to an active DDP connection.

Implementations

impl Connection

pub async fn connect(url: &str) -> Result<Self>

Create a new connection to the given websocket endpoint. the url parameter is passed as-is to async_tungstenite::tokio

pub async fn connect_with_websocket(
    stream: WebSocketStream<Stream<TokioAdapter<TcpStream>, TokioAdapter<TlsStream<TcpStream>>>>
) -> Result<Self>

Create a new connection from an existing tungstenite websocket stream.

pub fn stream(&mut self) -> &mut impl Stream<Item = ServerMessage>

Access the inbound stream of messages. Pings are automatically answered, all subscription-related messages will be passed down indiscriminatedly.

pub async fn recv(&mut self) -> Option<ServerMessage>

Convenience method to consume a single message from the inbound stream.

pub fn handle(&self) -> Handle

Acquire a handle that can be used to make RPC calls without borrowing the main connection.

pub async fn call(
    &mut self,
    name: String,
    params: Vec<Value>
) -> Result<MethodResult>

See Handle::call

pub async fn subscribe(
    &mut self,
    id: String,
    name: String,
    params: Vec<Value>
) -> Result<()>

Subscribe to a collection. You need to provide a unique subscription ID.

pub async fn unsubscribe(&mut self, id: String) -> Result<()>

Unsubscribe from a previously subscribed connection.

Trait Implementations

impl Debug for Connection

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

Formats the value using the given formatter.