Struct ServerError 

pub struct ServerError { /* private fields */ }

A code and message exactly as the server supplied them.

The code is preserved as a number so a caller can branch on it; the message is whatever human-readable text accompanied it, and may be empty. Which catalog the code comes from is determined by the Error variant carrying this value — see the module documentation.

Examples

use lightstreamer_rs::Error;

fn is_bad_credentials(error: &Error) -> bool {
    // Appendix A code 1 is "user/password check failed".
    matches!(error, Error::Session(cause) if cause.code() == 1)
}

Implementations

impl ServerError

pub fn new(code: i64, message: impl Into<String>) -> Self

Wraps a code and message as the server sent them.

pub const fn code(&self) -> i64

The numeric code, exactly as received.

pub fn message(&self) -> &str

The accompanying text, which the server is allowed to leave empty.

pub const fn is_adapter_defined(&self) -> bool

Whether this code came from the server’s Metadata Adapter rather than from the protocol’s own catalog.

A code of 0 or below is supplied by the Adapter and its meaning is entirely application-specific: no interpretation in docs/spec/05-error-codes.md applies to it, and only the application that wrote the Adapter knows what it means [docs/spec/05-error-codes.md §2].

Trait Implementations

impl Clone for ServerError

fn clone(&self) -> ServerError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerError

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

Formats the value using the given formatter.

impl Display for ServerError

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

Formats the value using the given formatter.

impl Eq for ServerError

impl Hash for ServerError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ServerError

fn cmp(&self, other: &ServerError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ServerError

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ServerError

fn partial_cmp(&self, other: &ServerError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ServerError