Skip to main content

ClientState

Enum ClientState 

Source
pub enum ClientState {
    ConnectTokenExpired,
    InvalidConnectToken,
    ConnectionTimedOut,
    ConnectionResponseTimedOut,
    ConnectionRequestTimedOut,
    ConnectionDenied,
    Disconnected,
    SendingConnectionRequest,
    SendingConnectionResponse,
    Connected,
}
Expand description

The state of a Client.

The initial state is Disconnected; the goal state is Connected. The is_error, is_connecting and is_disconnected predicates classify the rest.

Variants§

§

ConnectTokenExpired

The connect token expired before the client finished connecting.

§

InvalidConnectToken

The connect token passed to Client::connect was invalid.

§

ConnectionTimedOut

The established connection timed out.

§

ConnectionResponseTimedOut

The server stopped responding while the client was sending connection responses.

§

ConnectionRequestTimedOut

The server never responded to the client’s connection requests.

§

ConnectionDenied

The server denied the connection (for example, because it was full).

§

Disconnected

Not connected. The initial state.

§

SendingConnectionRequest

Sending connection request packets to the server.

§

SendingConnectionResponse

Sending connection response packets to the server.

§

Connected

Connected: payload packets can be exchanged with the server.

Implementations§

Source§

impl ClientState

Source

pub fn is_error(self) -> bool

Whether this is one of the error states.

Source

pub fn is_connecting(self) -> bool

Whether the client is partway through connecting: sending connection requests or connection responses.

Source

pub fn is_disconnected(self) -> bool

Whether the client is disconnected, either cleanly (Disconnected) or in an error state.

Trait Implementations§

Source§

impl Clone for ClientState

Source§

fn clone(&self) -> ClientState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ClientState

Source§

impl Debug for ClientState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ClientState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ClientState

Source§

impl PartialEq for ClientState

Source§

fn eq(&self, other: &ClientState) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ClientState

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.