Enum DdsError 

#[non_exhaustive]
pub enum DdsError {
    BadParameter {
        what: &'static str,
    },
    PreconditionNotMet {
        reason: &'static str,
    },
    WireError {
        message: String,
    },
    InconsistentPolicy {
        what: &'static str,
    },
    TransportError {
        label: &'static str,
    },
    OutOfResources {
        what: &'static str,
    },
    Timeout,
    Unsupported {
        feature: &'static str,
    },
    NotAllowedBySecurity {
        what: &'static str,
    },
    IllegalOperation {
        what: &'static str,
    },
    ImmutablePolicy {
        policy: &'static str,
    },
    AlreadyDeleted,
    NoData,
    Other {
        reason: &'static str,
    },
    NotEnabled,
}

Errors from DCPS operations. Roughly analogous to the spec ReturnCode_t enum; we omit RETCODE_OK (using Result::Ok instead) and merge BAD_PARAMETER + PRECONDITION_NOT_MET where the distinction doesn’t help.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BadParameter

Invalid parameter (e.g. an empty topic name).

Fields

what: &'static str

Which parameter, briefly.

PreconditionNotMet

Operation does not fit the entity state (e.g. write on a DataWriter whose participant has been shut down).

Fields

reason: &'static str

Short description.

WireError

Underlying wire/CDR operation failed.

Fields

message: String

Message, static or dynamic.

InconsistentPolicy

QoS policy set is not consistent. Example: Reliability= Best-Effort + History=KeepAll without resource_limits — Spec §2.2.3 lists some incompatible combinations.

Fields

what: &'static str

Which policy/policies collide.

TransportError

Transport operation failed.

Fields

label: &'static str

Static label of the error.

OutOfResources

Resource limit reached (max_samples, max_instances, etc.).

Fields

what: &'static str

Which limit.

Timeout

Timeout on a blocking operation (take_w_timeout, etc.).

Unsupported

Operation not implemented in v1.2.

Fields

feature: &'static str

Short description.

NotAllowedBySecurity

Operation forbidden by the security policy — DDS-Security 1.2 §7.3.25, DCPS 1.4 §2.2.2.1.1 ReturnCode_t = NOT_ALLOWED_BY_SECURITY. The permissions/access plugin denied the read/write on a protected topic; the caller must not learn which permissions detail was the cause (information leak).

Fields

what: &'static str

Short, security-noncritical description.

IllegalOperation

IllegalOperation — the operation does not fit structurally (e.g. write() on a DataReader). DCPS 1.4 §2.2.2.1.1 ReturnCode_t = ILLEGAL_OPERATION.

Fields

what: &'static str

What does not work.

ImmutablePolicy

ImmutablePolicy — set_qos on a post-enable immutable QoS policy. DCPS 1.4 §2.2.2.1.1 ReturnCode_t = IMMUTABLE_POLICY.

Fields

policy: &'static str

Which policy.

AlreadyDeleted

AlreadyDeleted — operation on a deleted entity. DCPS 1.4 §2.2.2.1.1 ReturnCode_t = ALREADY_DELETED.

NoData

NoData — read/take with no new samples. DCPS 1.4 §2.2.2.1.1 ReturnCode_t = NO_DATA. In practice often returned as an empty sample Vec rather than as an error.

Other

Error — generic, non-specific error. DCPS 1.4 §2.2.2.1.1 ReturnCode_t = ERROR. Last resort when no more specific variant fits; avoids an information leak toward the caller.

Fields

reason: &'static str

Short description.

NotEnabled

NotEnabled — operation on an entity that has not yet been activated via enable(). DCPS 1.4 §2.2.2.1.1 ReturnCode_t = NOT_ENABLED. §2.1.2 — entities are disabled after create_* until enable(); many ops must then return NotEnabled.

Implementations

impl DdsError

pub fn as_return_code(&self) -> i32

Maps the error to the OMG ReturnCode_t integer value (DCPS 1.4 §2.2.2.1.1). WireError and TransportError are mapped to RETCODE_ERROR (1) — this is spec-conformant: both are unspecified implementation errors.

Trait Implementations

impl Clone for DdsError

fn clone(&self) -> DdsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DdsError

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

Formats the value using the given formatter.

impl Display for DdsError

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

Formats the value using the given formatter.

impl Eq for DdsError

impl Error for DdsError

Available on crate feature std only.

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 DdsError

fn eq(&self, other: &DdsError) -> 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 StructuralPartialEq for DdsError