Struct ExitCode 

pub struct ExitCode(ExitCode);

Newtype wrapper for the FVM ExitCode.

Examples

let fvm2_success = fvm_shared2::error::ExitCode::new(0);
let fvm3_success = fvm_shared3::error::ExitCode::new(0);

let shim_from_v2 = ExitCode::from(fvm2_success);
let shim_from_v3 = ExitCode::from(fvm3_success);

assert_eq!(shim_from_v2, shim_from_v3);
assert_eq!(shim_from_v2, fvm2_success.into());
assert_eq!(shim_from_v3, fvm3_success.into());

Tuple Fields

0: ExitCode

Implementations

impl ExitCode

pub const FIRST_USER_EXIT_CODE: u32 = ExitCode_latest::FIRST_USER_EXIT_CODE

The lowest exit code that an actor may abort with.

pub const SYS_OUT_OF_GAS: Self

Message execution (including sub-calls) used more gas than the specified limit.

pub const SYS_INSUFFICIENT_FUNDS: Self

The message sender didn’t have the requisite funds.

pub const FIRST_ACTOR_ERROR_CODE: u32 = 16

The initial range of exit codes is reserved for system errors. Actors may define codes starting with this one.

pub fn value(&self) -> u32

pub fn is_success(&self) -> bool

pub const fn new(value: ExitCode_latest) -> Self

Trait Implementations

impl Clone for ExitCode

fn clone(&self) -> ExitCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExitCode

impl Debug for ExitCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExitCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExitCode

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

Formats the value using the given formatter.

impl Eq for ExitCode

impl From<ExitCode> for ExitCode

fn from(value: ExitCodeV4) -> Self

Converts to this type from the input type.

impl From<ExitCode> for ExitCode

fn from(value: ExitCode) -> Self

Converts to this type from the input type.

impl From<ExitCode> for ExitCode

fn from(value: ExitCodeV3) -> Self

Converts to this type from the input type.

impl From<ExitCode> for ExitCode

fn from(value: ExitCodeV2) -> Self

Converts to this type from the input type.

impl From<ExitCode> for ExitCode

fn from(value: ExitCode) -> Self

Converts to this type from the input type.

impl From<ExitCode> for ExitCode

fn from(value: ExitCode) -> Self

Converts to this type from the input type.

impl From<u32> for ExitCode

fn from(value: u32) -> Self

Converts to this type from the input type.

impl JsonSchema for ExitCode

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ExitCode

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

fn partial_cmp(&self, other: &Self) -> 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 Serialize for ExitCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExitCode