Struct fuel_asm::RegId

pub struct RegId(_);

Represents a 6-bit register ID, guaranteed to be masked by construction.

Implementations

impl RegId

pub const ZERO: Self = _

Contains zero (0), for convenience.

pub const ONE: Self = _

Contains one (1), for convenience.

pub const OF: Self = _

Contains overflow/underflow of addition, subtraction, and multiplication.

pub const PC: Self = _

The program counter. Memory address of the current instruction.

pub const SSP: Self = _

Stack start pointer. Memory address of bottom of current writable stack area.

pub const SP: Self = _

Stack pointer. Memory address on top of current writable stack area (points to free memory).

pub const FP: Self = _

Frame pointer. Memory address of beginning of current call frame.

pub const HP: Self = _

Heap pointer. Memory address below the current bottom of the heap (points to free memory).

pub const ERR: Self = _

Error codes for particular operations.

pub const GGAS: Self = _

Remaining gas globally.

pub const CGAS: Self = _

Remaining gas in the context.

pub const BAL: Self = _

Received balance for this context.

pub const IS: Self = _

Instructions start. Pointer to the start of the currently-executing code.

pub const RET: Self = _

Return value or pointer.

pub const RETL: Self = _

Return value length in bytes.

pub const FLAG: Self = _

Flags register.

pub const WRITABLE: Self = _

Smallest writable register.

pub const fn new(u: u8) -> Self

Construct a register ID from the given value.

The given value will be masked to 6 bits.

pub fn new_checked(u: u8) -> Option<Self>

Construct a register ID from the given value.

Returns None if the value is outside the 6-bit value range.

pub const fn to_u8(self) -> u8

A const alternative to the Into<u8> implementation.

Trait Implementations

impl CheckRegId for RegId

fn check(self) -> RegId

Convert to a RegId, or panic

impl Clone for RegId

fn clone(&self) -> RegId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegId

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

Formats the value using the given formatter.

impl From<RegId> for u8

fn from(RegId: RegId) -> Self

Converts to this type from the input type.

impl From<RegId> for usize

fn from(r: RegId) -> usize

Converts to this type from the input type.

impl From<u8> for RegId

fn from(u: u8) -> Self

Converts to this type from the input type.

impl Hash for RegId

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<T> Index<RegId> for [T]where
[T]: Index<usize, Output = T>,

type Output = T

The returned type after indexing.

fn index(&self, ix: RegId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<RegId> for [T]where
[T]: IndexMut<usize, Output = T>,

fn index_mut(&mut self, ix: RegId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for RegId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<RegId> for RegId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<RegId> for RegId

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for RegId

impl Eq for RegId

impl StructuralEq for RegId

impl StructuralPartialEq for RegId