Struct servers::plugins::prelude::Client

pub struct Client {
    pub id: usize,
    pub stream: ClientStream,
    pub map: Arc<Mutex<HashMap<String, ClientMapValue>>>,
    pub plugins_manager: PluginsManagerType,
}

Client struct

Fields

id: usize

ID of the client

stream: ClientStream

Connection stream of the client

map: Arc<Mutex<HashMap<String, ClientMapValue>>>

Custom Client Map

plugins_manager: PluginsManagerType

Plugins Manager

Implementations

impl Client

pub fn new_tcp(stream: TcpStream, id: usize) -> Self

Create a new TCP Client instance

pub fn new_websocket(stream: TcpStream, id: usize) -> Result<Self>

Create a new WebSocket Client instance

pub fn read(&self) -> Result<String>

Recieve a message from the client

pub fn send<S>(&self, msg: S) -> Result<()>where
    S: ToString,
    S: Display,

Send a message to the client

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the socket address of the remote peer of this connection.

pub fn flush(&self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn close(&self) -> Result<()>

Close the client connection

pub fn insert_key<S>(
    &self,
    key: S,
    value: ClientMapValue
) -> Option<ClientMapValue>where
    S: ToString,

Inserts a key-value pair into the map.

pub fn get_value<S>(&self, key: S) -> Option<ClientMapValue>where
    S: ToString,

Returns the value from the key.

pub fn delete_key<S>(&self, key: S) -> Option<ClientMapValue>where
    S: ToString,

Delete key from the map.

pub async fn run_events(
    &self,
    event_type: EventType,
    event_data: EventData
) -> Result<()>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl From<TcpStream> for Client

fn from(stream: TcpStream) -> Self

Converts to this type from the input type.

impl From<WebSocket<TcpStream>> for Client

fn from(stream: WebSocket<TcpStream>) -> Self

Converts to this type from the input type.