Enum ServerInfo 

#[non_exhaustive]
pub enum ServerInfo {
    ServerName(String),
    ClientIp(String),
    BandwidthLimit {
        kbps: Option<String>,
        managed: bool,
    },
    UnreadableBandwidthLimit {
        literal: String,
    },
    Clock {
        elapsed_seconds: u64,
    },
}

Something the server said about itself or about the session, which changes nothing but may be worth logging.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ServerName(String)

The configured name of the server port the session is bound to. Diagnostic only [docs/spec/04-notifications.md §5.4].

ClientIp(String)

The client’s own address, as the server sees it. A change between two binds means the client moved network [docs/spec/04-notifications.md §5.3].

BandwidthLimit

The bandwidth limit now in force for the session [docs/spec/04-notifications.md §5.1].

Fields

kbps: Option<String>

The limit in kbps, exactly as the server wrote it, or None when the server declared no limit.

managed: bool

Whether the client is forbidden to change the limit — the server’s unmanaged answer.

UnreadableBandwidthLimit

The bandwidth constraint could not be read, so do not treat it as a limit [docs/spec/04-notifications.md §5.1].

The server sent something that is neither unlimited, nor unmanaged, nor a decimal number. It is reported apart from BandwidthLimit rather than as a limit of Some(""), because a caller acting on a fabricated number is worse off than one told the value was unreadable. What the session’s real limit is remains whatever the last readable CONS said.

Fields

literal: String

The value as it arrived.

Clock

How long the server thinks the session has been bound [docs/spec/04-notifications.md §5.2].

Comparing it with your own elapsed time detects a client falling behind the update flow, or a machine that was suspended. This crate reports it and acts on it in no way.

Fields

elapsed_seconds: u64

Seconds elapsed on the server since the session was bound.

Trait Implementations

impl Clone for ServerInfo

fn clone(&self) -> ServerInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerInfo

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

Formats the value using the given formatter.

impl Eq for ServerInfo

impl PartialEq for ServerInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ServerInfo