cross-ws 0.3.3

cross-ws is a web and native stream based WebSocket client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! Traits module.

use std::future::Future;

use crate::{Message, Result};

/// WebSocket trait.
pub trait WebSocketTrait: Sized {
    /// Sender type.
    type Sender: WebSocketSenderTrait;
    /// Receiver type.
    type Receiver: WebSocketReceiverTrait;

    /// Creates a new WebSocket and connects it to the specified `url`.

    fn new(url: &str) -> impl Future<Output = Result<(Self::Sender, Self::Receiver)>>;
}

/// WebSocket sender trait.
pub trait WebSocketSenderTrait {
    /// Sends a message.
    fn send(&mut self, message: Message) -> impl Future<Output = Result<()>>;
    /// Closes the WebSocket.
    fn close(&mut self, message: Option<(u16, String)>) -> impl Future<Output = Result<()>>;
}

/// WebSocket receiver trait.
pub trait WebSocketReceiverTrait {
    /// Receives a message.
    fn next(&mut self) -> impl Future<Output = Result<Option<Message>>>;
}