Struct Error

pub struct Error<T = ()> { /* private fields */ }

An error with a kind and a msg.

An Error contains a ErrorKind which gives context on the error cause, as well as an Option<T> which may be used to prevent the loss of data in case of a failed send function call. When no T is specified, it defaults to ().

Usage example

use libzmq::{prelude::*, *, ErrorKind::*};

// This client has no peer and is therefore in mute state.
let client = Client::new()?;

// This means that the following call would block.
if let Err(mut err) = client.try_send("msg") {
    match err.kind() {
        // This covers all the possible error scenarios for this socket type.
        // Normally we would process each error differently.
        WouldBlock | InvalidCtx | Interrupted => {
            // Here we get back the message we tried to send.
            let msg = err.take().unwrap();
            assert_eq!("msg", msg.to_str()?);
        }
        // Since `ErrorKind` is non-exhaustive, need an
        // extra wildcard arm to account for potential future variants.
        _ => panic!("unhandled error : {}", err),
    }
}

Implementations

impl<T> Error<T>

pub fn kind(&self) -> ErrorKind

Returns the kind of error.

pub fn content(&self) -> Option<&T>

👎Deprecated since 0.2.1: please use get instead

pub fn get(&self) -> Option<&T>

Returns a reference to the content held by the error.

pub fn take_content(&mut self) -> Option<T>

👎Deprecated since 0.2.1: please use take instead

pub fn take(&mut self) -> Option<T>

Takes the content held by the error, if any, replacing with None.

pub fn cast<I>(self) -> Error<I>

This allows casting to any Error<I> by replacing the content of the error with None.

This is not implemented as Into<Error<I>> to be explicit since information is lost in the conversion.

Trait Implementations

impl<T> Debug for Error<T>

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

Formats the value using the given formatter.

impl<T> Display for Error<T>

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

Formats the value using the given formatter.

impl<T> Error for Error<T>

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

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl<T> From<AddrParseError> for Error<T>

fn from(error: AddrParseError) -> Self

Converts to this type from the input type.

impl<T> From<Error<T>> for Error

fn from(err: Error<T>) -> Error

Converts to this type from the input type.

impl<T> From<GroupParseError> for Error<T>

fn from(_error: GroupParseError) -> Self

Converts to this type from the input type.

impl<T> From<Infallible> for Error<T>

fn from(_error: Infallible) -> Self

Converts to this type from the input type.