Enum RclrsError

pub enum RclrsError {
    RclError {
        code: RclReturnCode,
        msg: Option<RclErrorMsg>,
    },
    UnknownRclError {
        code: i32,
        msg: Option<RclErrorMsg>,
    },
    StringContainsNul {
        s: String,
        err: NulError,
    },
    AlreadyAddedToWaitSet,
}

The main error type.

Variants

RclError

An error originating in the rcl layer.

Fields

code: RclReturnCode

The error code.

msg: Option<RclErrorMsg>

The error message set in the rcl layer or below.

UnknownRclError

An unknown error originating in the rcl layer.

Fields

code: i32

The error code.

msg: Option<RclErrorMsg>

The error message set in the rcl layer or below.

StringContainsNul

A string provided to rclrs could not be converted into a CString.

Fields

s: String

The string that contains a nul byte.

err: NulError

The error indicating the position of the nul byte.

AlreadyAddedToWaitSet

It was attempted to add a waitable to a wait set twice.

Implementations

impl RclrsError

pub fn is_timeout(&self) -> bool

Returns true if the error was due to a timeout, otherwise returns false.

pub fn is_take_failed(&self) -> bool

Returns true if the error was because a subscription, service, or client take failed, otherwise returns false.

Trait Implementations

impl Debug for RclrsError

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

Formats the value using the given formatter.

impl Display for RclrsError

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

Formats the value using the given formatter.

impl Error for RclrsError

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 PartialEq for RclrsError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RclrsError

impl StructuralPartialEq for RclrsError