Struct fuel_asm::RegId

pub struct RegId(/* private fields */);

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

Implementations

impl RegId

pub const BAL: Self = _

Received balance for this context.

pub const CGAS: Self = _

Remaining gas in the context.

pub const ERR: Self = _

Error codes for particular operations.

pub const FLAG: Self = _

Flags register.

pub const FP: Self = _

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

pub const GGAS: Self = _

Remaining gas globally.

pub const HP: Self = _

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

pub const IS: Self = _

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

pub const OF: Self = _

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

pub const ONE: Self = _

Contains one (1), for convenience.

pub const PC: Self = _

The program counter. Memory address of the current instruction.

pub const RET: Self = _

Return value or pointer.

pub const RETL: Self = _

Return value length in bytes.

pub const SP: Self = _

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

pub const SSP: Self = _

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

pub const WRITABLE: Self = _

Smallest writable register.

pub const ZERO: Self = _

Contains zero (0), for convenience.

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 const fn to_u8(self) -> u8

A const alternative to the Into<u8> implementation.

impl RegId

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

Construct a register ID from the given value.

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

impl RegId

pub fn bal() -> Self

Available on crate feature typescript only.

Received balance for this context.

pub fn cgas() -> Self

Available on crate feature typescript only.

Remaining gas in the context.

pub fn err() -> Self

Available on crate feature typescript only.

Error codes for particular operations.

pub fn flag() -> Self

Available on crate feature typescript only.

Flags register.

pub fn fp() -> Self

Available on crate feature typescript only.

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

pub fn ggas() -> Self

Available on crate feature typescript only.

Remaining gas globally.

pub fn hp() -> Self

Available on crate feature typescript only.

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

pub fn is() -> Self

Available on crate feature typescript only.

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

pub fn of() -> Self

Available on crate feature typescript only.

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

pub fn one() -> Self

Available on crate feature typescript only.

Contains one (1), for convenience.

pub fn pc() -> Self

Available on crate feature typescript only.

The program counter. Memory address of the current instruction.

pub fn ret() -> Self

Available on crate feature typescript only.

Return value or pointer.

pub fn retl() -> Self

Available on crate feature typescript only.

Return value length in bytes.

pub fn sp() -> Self

Available on crate feature typescript only.

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

pub fn spp() -> Self

Available on crate feature typescript only.

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

pub fn writable() -> Self

Available on crate feature typescript only.

Smallest writable register.

pub fn zero() -> Self

Available on crate feature typescript only.

Contains zero (0), for convenience.

pub fn new_typescript(u: u8) -> Self

Available on crate feature typescript only.

Construct a register ID from the given value.

The given value will be masked to 6 bits.

pub fn to_u8_typescript(self) -> u8

Available on crate feature typescript only.

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 JsValue

fn from(value: RegId) -> Self

Converts to this type from the input type.

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 FromWasmAbi for RegId

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

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 IntoWasmAbi for RegId

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for RegId

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, RegId>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for RegId

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for RegId

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl Ord for RegId

fn cmp(&self, other: &RegId) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 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 RefFromWasmAbi for RegId

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, RegId>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for RegId

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, RegId>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for RegId

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for RegId

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[RegId]>

impl VectorIntoWasmAbi for RegId

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[RegId]>) -> Self::Abi

impl WasmDescribe for RegId

fn describe()

impl WasmDescribeVector for RegId

fn describe_vector()

impl Copy for RegId

impl Eq for RegId

impl StructuralPartialEq for RegId