Enum rustdds::Error

pub enum Error {
    BadParameter {
        reason: String,
    },
    Unsupported,
    OutOfResources,
    NotEnabled,
    ImmutablePolicy,
    InconsistentPolicy {
        reason: String,
    },
    PreconditionNotMet {
        precondition: String,
    },
    IllegalOperation {
        reason: String,
    },
    LockPoisoned,
    Internal {
        reason: String,
    },
    Io(Error),
    Serialization {
        reason: String,
    },
    Discovery {
        reason: String,
    },
}

This corresponds to “Return codes” in DDS spec 2.2.1.1 Format and Conventions

Deviations from the DDS spec:

• OK is not included. It is not an error. Ok/Error should be distinguished with the Result type.
• Error is too unspecific.
• AlreadyDeleted We should use Rust type system to avoid these, so no need for run-time error.
• Timeout This is normal operation and should be encoded as Option or Result
• NoData This should be encoded as Option<SomeData>, not an error code.

Variants

BadParameter

Fields

reason: String

Illegal parameter value.

Unsupported

Unsupported operation. Can only be returned by operations that are optional.

OutOfResources

Service ran out of the resources needed to complete the operation.

NotEnabled

Operation invoked on an Entity that is not yet enabled.

ImmutablePolicy

Application attempted to modify an immutable QosPolicy.

InconsistentPolicy

Fields

reason: String

Application specified a set of policies that are not consistent with each other.

PreconditionNotMet

Fields

precondition: String

A pre-condition for the operation was not met.

IllegalOperation

Fields

reason: String

An operation was invoked on an inappropriate object or at an inappropriate time (as determined by policies set by the specification or the Service implementation). There is no precondition that could be changed to make the operation succeed.

LockPoisoned

Synchronization with another thread failed because the other thread has exited while holding a lock. Does not exist in the DDS spec.

Internal

Fields

reason: String

Something that should not go wrong went wrong anyway. This is usually a bug in RustDDS

Io(Error)

Tuple Fields

0: Error

Serialization

Fields

reason: String

Discovery

Fields

reason: String

Implementations

impl Error

pub fn bad_parameter<T>(reason: impl Into<String>) -> Result<T>

pub fn precondition_not_met<T>(precondition: impl Into<String>) -> Result<T>

Trait Implementations

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(source: Error) -> Self

Performs the conversion.

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

fn from(_e: PoisonError<T>) -> Error

Performs the conversion.

impl<T> From<TrySendError<T>> for Error where
    TrySendError<T>: Error, 

fn from(e: TrySendError<T>) -> Error

Performs the conversion.