Enum ClosedReason 

#[non_exhaustive]
pub enum ClosedReason {
    ByClient,
    ByServer(ServerError),
    ReconnectExhausted {
        attempts: u32,
        last: Option<Box<DisconnectReason>>,
    },
    Internal {
        reason: String,
    },
}

Why the session ended for good.

After this the client is inert: every operation returns Error::Disconnected and no further event arrives.

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.

ByClient

You asked for it — Client::disconnect, or the client was dropped.

ByServer(ServerError)

The server ended the session, or refused to start one, with an Appendix A code that admits no retry [docs/spec/05-error-codes.md §2].

ReconnectExhausted

The connection kept failing and the reconnection budget ran out.

Fields

attempts: u32

How many consecutive attempts failed.

last: Option<Box<DisconnectReason>>

Why the last attempt failed, when there was one to report.

The count alone says a client gave up; it does not say whether the server was refusing the credentials, the socket never opened, or the connection kept going silent — which are three different things to do about it. This is that answer, in the same vocabulary SessionEvent::Disconnected uses.

Internal

A failure inside this crate. A bug; please report it.

Fields

reason: String

What failed. Never contains a credential.

Implementations

impl ClosedReason

pub fn into_error(self) -> Error

The same reason expressed as an Error, for a caller that wants to propagate it with ?.

Examples

use lightstreamer_rs::{ClosedReason, Error};

let reason = ClosedReason::ReconnectExhausted { attempts: 8, last: None };
assert!(matches!(reason.into_error(), Error::ReconnectExhausted { attempts: 8, .. }));

Trait Implementations

impl Clone for ClosedReason

fn clone(&self) -> ClosedReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClosedReason

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

Formats the value using the given formatter.

impl Eq for ClosedReason

impl PartialEq for ClosedReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClosedReason