Enum lsl::Error

pub enum Error {
    BadArgument,
    Timeout,
    StreamLost,
    ResourceCreation,
    Internal,
    Unknown,
}

Error type for all errors that can be returned by this library.

Variants

BadArgument

A bad argument was passed into a library function (e.g., negative number, string containing embedded zero bytes (which C libraries tend to not accept).

Timeout

A user-provided timeout has expired.

StreamLost

The stream that this is reading from has disappeared from the network and is unrecoverable. This can only happen if the stream had an empty source_id or if you turned off recovery.

ResourceCreation

Resource creation failed. This is usually due to OS resource exhaustion (e.g., out of memory, thread handles, sockets, or the like).

Internal

An internal error happened in the library. This is generally unlikely but can be returned by a variety of library calls.

Unknown

An unknown error has happened. There are only very few calls where this can happen since no detailed error codes are available in those cases, and is very unlikely to occur.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

Error trait for the custom Error enum. Since no further source information is available, this is omitted.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<NulError> for Error

fn from(_: NulError) -> Error

Performs the conversion.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Error

impl StructuralPartialEq for Error