Enum sshx_server::web::protocol::WsClient

pub enum WsClient {
    Authenticate(Bytes),
    SetName(String),
    SetCursor(Option<(i32, i32)>),
    SetFocus(Option<Sid>),
    Create(i32, i32),
    Close(Sid),
    Move(Sid, Option<WsWinsize>),
    Data(Sid, Bytes, u64),
    Subscribe(Sid, u64),
    Chat(String),
    Ping(u64),
}

A real-time message sent from the client over WebSocket.

Variants

Authenticate(Bytes)

Authenticate the user’s encryption key by zeros block.

SetName(String)

Set the name of the current user.

SetCursor(Option<(i32, i32)>)

Send real-time information about the user’s cursor.

SetFocus(Option<Sid>)

Set the currently focused shell.

Create(i32, i32)

Create a new shell.

Close(Sid)

Close a specific shell.

Move(Sid, Option<WsWinsize>)

Move a shell window to a new position and focus it.

Data(Sid, Bytes, u64)

Add user data to a given shell.

Subscribe(Sid, u64)

Subscribe to a shell, starting at a given chunk index.

Chat(String)

Send a a chat message to the room.

Ping(u64)

Send a ping to the server, for latency measurement.

Trait Implementations

impl Clone for WsClient

fn clone(&self) -> WsClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WsClient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsClient

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WsClient

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.