RUMClient

Struct RUMClient 

Source
pub struct RUMClient { /* private fields */ }
Expand description

This structs encapsulates the tokio::net::TcpStream instance that will be our adapter for connecting and sending messages to a peer or server.

Implementations§

Source§

impl RUMClient

Source

pub async fn connect(ip: &str, port: u16) -> RUMResult<RUMClient>

Connect to peer and construct the client.

Source

pub async fn accept(socket: TcpStream) -> RUMResult<RUMClient>

If a connection was already pre-established elsewhere, construct our client with the connected socket.

Source

pub async fn send(&mut self, msg: &RUMNetMessage) -> RUMResult<()>

Send message to server.

Source

pub async fn recv(&mut self) -> RUMResult<RUMNetMessage>

Receive message from server. This method will make calls to RUMClient::recv_some indefinitely until we have the full message or stop receiving any data.

Source

pub async fn wait_incoming(&self) -> RUMResult<bool>

Source

pub async fn read_ready(&self) -> bool

Check if socket is ready for reading.

Source

pub async fn write_ready(&self) -> bool

Check if socket is ready for writing.

Source

pub async fn get_address(&self, local: bool) -> Option<RUMString>

Returns the peer address:port as a string.

Source

pub fn is_disconnected(&self) -> bool

Source

pub fn disconnect(&mut self)

Trait Implementations§

Source§

impl Debug for RUMClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.