Enum GenApiError 

#[non_exhaustive]
pub enum GenApiError {
    NodeNotFound(String),
    Type(String),
    Access(String),
    Locked {
        name: String,
        locked_by: String,
    },
    Range(String),
    Unavailable(String),
    Io(String),
    Parse(String),
    Unsupported(String),
    ExprParse {
        name: String,
        msg: String,
    },
    ExprEval {
        name: String,
        msg: String,
    },
    UnknownVariable {
        name: String,
        var: String,
    },
    EnumValueUnknown {
        node: String,
        value: i64,
    },
    EnumNoSuchEntry {
        node: String,
        entry: String,
    },
    BadIndirectAddress {
        name: String,
        addr: i64,
    },
    BitfieldOutOfRange {
        name: String,
        bit_offset: u16,
        bit_length: u16,
        len: usize,
    },
    ValueTooWide {
        name: String,
        value: i64,
        bit_length: u16,
    },
}

Error type produced by GenApi operations.

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.

NodeNotFound(String)

The requested node does not exist in the nodemap.

Type(String)

The node exists but has a different type.

Access(String)

The node access mode forbids the attempted operation.

Locked

The node declares pIsLocked and the device currently reports it locked, so the write was refused locally.

Names the locking feature, because that is the actionable part: a caller told only “access denied” has nowhere to go, whereas “ExposureTime is locked by ExposureTime_Lck” points at the feature to change first. See ADR-0018 and backlog GA-06.

Fields

name: String

The node whose write was refused.

locked_by: String

The feature named by this node’s pIsLocked.

Range(String)

The provided value violates the limits declared by the node.

Unavailable(String)

The node is currently hidden by selector state.

Io(String)

Underlying register IO failed.

Parse(String)

Node metadata or conversion failed.

Unsupported(String)

A declaration this crate has no builder for.

[viva_genapi_xml::NodeDecl] is #[non_exhaustive], so a node type added to the XML layer no longer breaks this crate’s build. It surfaces here instead, at nodemap construction, and lands in crate::NodeMap::skipped where the corpus test will see it.

ExprParse

Parsing a SwissKnife expression failed.

Fields

name: String

msg: String

ExprEval

Evaluating a SwissKnife expression failed at runtime.

Fields

name: String

msg: String

UnknownVariable

A SwissKnife expression referenced an unknown variable.

Fields

name: String

var: String

EnumValueUnknown

Raw register value did not correspond to any enum entry.

Fields

node: String

value: i64

EnumNoSuchEntry

Attempted to select an enum entry that does not exist.

Fields

node: String

entry: String

BadIndirectAddress

Indirect addressing resolved to an invalid register.

Fields

name: String

addr: i64

BitfieldOutOfRange

Bitfield metadata exceeded the backing register width.

Fields

name: String

bit_offset: u16

bit_length: u16

len: usize

ValueTooWide

Provided value does not fit into the declared bitfield.

Fields

name: String

value: i64

bit_length: u16

Trait Implementations

impl Debug for GenApiError

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

Formats the value using the given formatter.

impl Display for GenApiError

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

Formats the value using the given formatter.

impl Error for GenApiError

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.