Enum ErrorCode 

#[repr(i32)]
pub enum ErrorCode {
    ERROR_CODE_UNSPECIFIED = 0,
    ERROR_CODE_INVALID_REQUEST = 1,
    ERROR_CODE_UNSUPPORTED_ALGORITHM = 2,
    ERROR_CODE_UNSUPPORTED_KEY_FORM = 3,
    ERROR_CODE_KEY_NOT_FOUND = 4,
    ERROR_CODE_USER_DECLINED = 5,
    ERROR_CODE_AUTHENTICATION_REQUIRED = 6,
    ERROR_CODE_HARDWARE_ERROR = 7,
    ERROR_CODE_TIMEOUT = 8,
    ERROR_CODE_INTERNAL = 99,
}

---

Errors. Every protocol response that can fail has an Error field; callers MUST check code before using any other field.

Variants

ERROR_CODE_UNSPECIFIED = 0

ERROR_CODE_INVALID_REQUEST = 1

The request was structurally invalid (missing required fields, unknown algorithm number, payload too large for this transport).

ERROR_CODE_UNSUPPORTED_ALGORITHM = 2

The signer does not support the requested algorithm.

ERROR_CODE_UNSUPPORTED_KEY_FORM = 3

The signer does not support the requested key form.

ERROR_CODE_KEY_NOT_FOUND = 4

The named key (by key_id or path) was not present.

ERROR_CODE_USER_DECLINED = 5

The user explicitly declined (touched the cancel button on a FIDO2 key, refused the TPM auth prompt, etc.).

ERROR_CODE_AUTHENTICATION_REQUIRED = 6

Authentication required (PIN, biometric, presence) and the signer is asking the caller to satisfy it via a follow-up request.

ERROR_CODE_HARDWARE_ERROR = 7

The hardware did not respond, returned a vendor-specific error, or is in an unrecoverable state. Error.message carries detail.

ERROR_CODE_TIMEOUT = 8

The operation timed out before the user satisfied a presence check or PIN prompt.

ERROR_CODE_INTERNAL = 99

Something went wrong inside the signer that we cannot map to a more specific code. Should be rare. Error.message MUST be set.

Implementations

impl ErrorCode

pub const Unspecified: Self = Self::ERROR_CODE_UNSPECIFIED

Idiomatic alias for Self::ERROR_CODE_UNSPECIFIED; Debug prints the variant name.

pub const InvalidRequest: Self = Self::ERROR_CODE_INVALID_REQUEST

Idiomatic alias for Self::ERROR_CODE_INVALID_REQUEST; Debug prints the variant name.

pub const UnsupportedAlgorithm: Self = Self::ERROR_CODE_UNSUPPORTED_ALGORITHM

Idiomatic alias for Self::ERROR_CODE_UNSUPPORTED_ALGORITHM; Debug prints the variant name.

pub const UnsupportedKeyForm: Self = Self::ERROR_CODE_UNSUPPORTED_KEY_FORM

Idiomatic alias for Self::ERROR_CODE_UNSUPPORTED_KEY_FORM; Debug prints the variant name.

pub const KeyNotFound: Self = Self::ERROR_CODE_KEY_NOT_FOUND

Idiomatic alias for Self::ERROR_CODE_KEY_NOT_FOUND; Debug prints the variant name.

pub const UserDeclined: Self = Self::ERROR_CODE_USER_DECLINED

Idiomatic alias for Self::ERROR_CODE_USER_DECLINED; Debug prints the variant name.

pub const AuthenticationRequired: Self = Self::ERROR_CODE_AUTHENTICATION_REQUIRED

Idiomatic alias for Self::ERROR_CODE_AUTHENTICATION_REQUIRED; Debug prints the variant name.

pub const HardwareError: Self = Self::ERROR_CODE_HARDWARE_ERROR

Idiomatic alias for Self::ERROR_CODE_HARDWARE_ERROR; Debug prints the variant name.

pub const Timeout: Self = Self::ERROR_CODE_TIMEOUT

Idiomatic alias for Self::ERROR_CODE_TIMEOUT; Debug prints the variant name.

pub const Internal: Self = Self::ERROR_CODE_INTERNAL

Idiomatic alias for Self::ERROR_CODE_INTERNAL; Debug prints the variant name.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for ErrorCode

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for ErrorCode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorCode

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Default for ErrorCode

fn default() -> Self

Returns the “default value” for a type.

impl Enumeration for ErrorCode

fn from_i32(value: i32) -> Option<Self>

Convert from an i32 wire value to the enum.

fn to_i32(&self) -> i32

Convert the enum to its i32 wire value.

fn proto_name(&self) -> &'static str

The name of this enum variant as it appears in the .proto file.

fn from_proto_name(name: &str) -> Option<Self>

Look up a variant by its protobuf name string.

fn values() -> &'static [Self]

All known variants of this enum, in proto declaration order.

impl Eq for ErrorCode

impl Hash for ErrorCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorCode