Enum StatusCode 

pub enum StatusCode {
    Success,
    NotImplemented,
    InvalidParameter,
    InvalidAddress,
    WriteProtect,
    BadAlignment,
    AccessDenied,
    Busy,
    GenericError,
    Unknown(u16),
}

Status codes shared by the GVCP and GenCP acknowledgement tables.

Only the codes both protocols define identically live here: 0x0000, 0x8001–0x8007 and 0x8FFF. Above that the tables diverge, and at 0x800B they actively disagree — GVCP calls it NO_MSG (deprecated), GenCP calls it MSG_TIMEOUT — so a transport-specific code must be decoded by that transport, not here. See ADR-0020.

Values corroborated by Wireshark’s GVCP dissector (epan/dissectors/packet-gvcp.c, GEV_STATUS_*) and aravis (arvgvcpprivate.h, arvuvcpprivate.h), which agree with each other.

Variants

Success

Command completed successfully.

NotImplemented

The requested command is not implemented by the device.

InvalidParameter

One of the command parameters was invalid or out of range.

InvalidAddress

The requested address does not exist on the device.

WriteProtect

Attempt to write to a read-only register.

A permanent condition: retrying cannot make it succeed.

BadAlignment

The access was not aligned as the underlying technology requires.

AccessDenied

Attempt to read a non-readable, or write a non-writable, register.

Distinct from StatusCode::WriteProtect: the register accepts writes in principle but the device is refusing this one, typically because a GenApi lock is engaged or control privilege is not held.

Busy

The device is busy and the command may succeed if retried.

The only status in this table worth a retry.

GenericError

The device reported a generic error with nothing more specific.

Unknown(u16)

A status code not known to this implementation, or specific to one transport. Carries the raw value so a caller can still report it.

Implementations

impl StatusCode

pub fn from_raw(raw: u16) -> Self

Convert from the raw status field in an acknowledgement header.

pub const fn to_raw(self) -> u16

Convert to the raw value stored in the packet header.

pub const fn name(self) -> &'static str

The specification’s name for this code, for diagnostics.

pub const fn is_retryable(self) -> bool

Whether retrying the command could plausibly succeed.

True only for StatusCode::Busy. Notably not WriteProtect or AccessDenied, which are refusals rather than congestion.

Trait Implementations

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StatusCode

impl Debug for StatusCode

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

Formats the value using the given formatter.

impl Display for StatusCode

Prints the specification name and the raw hex value.

Both halves matter: the name is what makes an error actionable, and the raw value is what lets a reporter match it against a capture. A bare decimal — which is what {:?} on the old Unknown(32774) produced — sent a user to the issue tracker in #45 unable to tell us anything.

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

Formats the value using the given formatter.

impl Eq for StatusCode

impl PartialEq for StatusCode

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