Enum SyscallName

pub enum SyscallName {
    Send,
    SendWGas,
    SendCommit,
    SendCommitWGas,
    SendInit,
    SendPush,
    ReservationSend,
    ReservationSendCommit,
    SendInput,
    SendPushInput,
    SendInputWGas,
    Reply,
    ReplyWGas,
    ReplyCommit,
    ReplyCommitWGas,
    ReplyPush,
    ReservationReply,
    ReservationReplyCommit,
    ReplyInput,
    ReplyPushInput,
    ReplyInputWGas,
    CreateProgram,
    CreateProgramWGas,
    Read,
    ReplyTo,
    SignalFrom,
    Size,
    ReplyCode,
    SignalCode,
    MessageId,
    ProgramId,
    Source,
    Value,
    EnvVars,
    BlockHeight,
    BlockTimestamp,
    GasAvailable,
    ValueAvailable,
    Exit,
    Leave,
    Wait,
    WaitFor,
    WaitUpTo,
    Wake,
    Panic,
    OomPanic,
    Alloc,
    Free,
    FreeRange,
    SystemBreak,
    ReplyDeposit,
    Debug,
    Random,
    ReserveGas,
    UnreserveGas,
    SystemReserveGas,
}

All available syscalls.

The type is mainly used to prevent from skipping syscall integration test for a newly introduced syscall or from typo in syscall name.

Variants

Send

SendWGas

SendCommit

SendCommitWGas

SendInit

SendPush

ReservationSend

ReservationSendCommit

SendInput

SendPushInput

SendInputWGas

Reply

ReplyWGas

ReplyCommit

ReplyCommitWGas

ReplyPush

ReservationReply

ReservationReplyCommit

ReplyInput

ReplyPushInput

ReplyInputWGas

CreateProgram

CreateProgramWGas

Read

ReplyTo

SignalFrom

Size

ReplyCode

SignalCode

MessageId

ProgramId

Source

Value

EnvVars

BlockHeight

BlockTimestamp

GasAvailable

ValueAvailable

Exit

Leave

Wait

WaitFor

WaitUpTo

Wake

Panic

OomPanic

Alloc

Free

FreeRange

SystemBreak

ReplyDeposit

Debug

Random

ReserveGas

UnreserveGas

SystemReserveGas

Implementations

impl SyscallName

pub fn to_str(&self) -> &'static str

Returns name of the syscall.

pub fn all() -> impl Iterator<Item = Self>

Returns iterator of all syscalls.

pub fn instrumentable() -> impl Iterator<Item = Self>

Returns iterator of all syscall names (actually supported by this module syscalls).

pub fn instrumentable_map() -> BTreeMap<String, SyscallName>

Returns map of all syscall string values to syscall names.

pub fn signature(self) -> SyscallSignature

Returns signature for syscall by name.

pub fn returns_error(self) -> bool

Checks whether the syscall returns error either by writing to input error pointer or by returning value indicating an error.

There are only 3 syscalls returning error value: Alloc, Free & FreeRange.

pub fn is_fallible(self) -> bool

Checks whether the syscall is fallible.

Note:

This differs from SyscallName::returns_error as fallible syscalls are those last param of which is a mutable error pointer.

Trait Implementations

impl Clone for SyscallName

fn clone(&self) -> SyscallName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyscallName

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

Formats the value using the given formatter.

impl Hash for SyscallName

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 SyscallName

fn cmp(&self, other: &SyscallName) -> 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 for SyscallName

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

fn partial_cmp(&self, other: &SyscallName) -> 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 Sequence for SyscallName

const CARDINALITY: usize = 56usize

Number of values of type Self.

fn next(&self) -> Option<Self>

Returns value following *self or None if this was the end.

fn previous(&self) -> Option<Self>

Returns value preceding *self or None if this was the beginning.

fn first() -> Option<Self>

Returns the first value of type Self.

fn last() -> Option<Self>

Returns the last value of type Self.

impl Copy for SyscallName

impl Eq for SyscallName

impl StructuralPartialEq for SyscallName