Enum RejectCode

#[repr(u32)]
pub enum RejectCode {
    SysFatal = 1,
    SysTransient = 2,
    DestinationInvalid = 3,
    CanisterReject = 4,
    CanisterError = 5,
    SysUnknown = 6,
    Unrecognized(u32),
}

Classifies why an API request or inter-canister call in the IC is rejected.

Note

Zero (0) is not a valid reject code. Converting 0 into this enum will return an error.

See Reject codes for more details.

Variants

SysFatal = 1

Fatal system error, retry unlikely to be useful.

SysTransient = 2

Transient system error, retry might be possible.

DestinationInvalid = 3

Invalid destination (e.g. canister/account does not exist).

CanisterReject = 4

Explicit reject by the canister.

CanisterError = 5

Canister error (e.g., trap, no response).

SysUnknown = 6

Response unknown; system stopped waiting for it (e.g., timed out, or system under high load).

Unrecognized(u32)

Unrecognized reject code.

Note

This variant is not part of the IC interface spec, and is used to represent reject codes that are not recognized by the library.

This variant is needed just in case the IC introduces new reject codes in the future. If that happens, a Canister using existing library versions will still be able to convert the new reject codes to this variant without panicking.

Trait Implementations

impl Clone for RejectCode

fn clone(&self) -> RejectCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RejectCode

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

Formats the value using the given formatter.

impl Display for RejectCode

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

Formats the value using the given formatter.

impl From<RejectCode> for u32

fn from(code: RejectCode) -> u32

Converts to this type from the input type.

impl Hash for RejectCode

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 Ord for RejectCode

fn cmp(&self, other: &RejectCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<u32> for RejectCode

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialEq for RejectCode

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd for RejectCode

fn partial_cmp(&self, other: &RejectCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u32> for RejectCode

type Error = ZeroIsInvalidRejectCode

The type returned in the event of a conversion error.

fn try_from(code: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for RejectCode

impl Eq for RejectCode

impl StructuralPartialEq for RejectCode