Enum soroban_env_host::Tag

#[repr(u8)]
pub enum Tag {
    False,
    True,
    Void,
    Error,
    U32Val,
    I32Val,
    U64Small,
    I64Small,
    TimepointSmall,
    DurationSmall,
    U128Small,
    I128Small,
    U256Small,
    I256Small,
    SymbolSmall,
    LedgerKeyContractInstance,
    SmallCodeUpperBound,
    ObjectCodeLowerBound,
    U64Object,
    I64Object,
    TimepointObject,
    DurationObject,
    U128Object,
    I128Object,
    U256Object,
    I256Object,
    BytesObject,
    StringObject,
    SymbolObject,
    VecObject,
    MapObject,
    AddressObject,
    ObjectCodeUpperBound,
    Bad,
}

Code values for the 8 tag bits in the bit-packed representation of Val. These don’t coincide with tag numbers in the SCVal XDR but cover all those cases as well as some optimized refinements for special cases (boolean true and false, small-value forms).

Variants

False

Tag for a Val that encodes bool false. The bool type is refined to two single-value subtypes in order for each tag number to coincides with the WASM encoding of a boolean.

True

Tag for a Val that encodes bool true.

Void

Tag for a Val that is empty/absent (eg. void, null, nil, undefined, None)

Error

Tag for a Val that is contains an error code.

U32Val

Tag for a Val that contains a u32 number.

I32Val

Tag for a Val that contains an i32 number.

U64Small

Tag for a Val that contains a u64 small enough to fit in 56 bits.

I64Small

Tag for a Val that contains an i64 small enough to fit in 56 bits.

TimepointSmall

Tag for a Val that contains a u64 timepoint small enough to fit in 56 bits.

DurationSmall

Tag for a Val that contains a u64 duration small enough to fit in 56 bits.

U128Small

Tag for a Val that contains a u128 small enough to fit in 56 bits.

I128Small

Tag for a Val that contains a i128 small enough to fit in 56 bits.

U256Small

Tag for a Val that contains a [u256] small enough to fit in 56 bits.

I256Small

Tag for a Val that contains a [i256] small enough to fit in 56 bits.

SymbolSmall

Tag for a Val that contains up to 9 character symbols.

LedgerKeyContractInstance

Tag for a Val that corresponds to stellar_xdr::ScVal::LedgerKeyContractInstance

SmallCodeUpperBound

Code delimiting the upper boundary of “small” types.

ObjectCodeLowerBound

Tag reserved to indicate boundary between tags for “small” types with their payload packed into the remaining 56 bits of the Val and “object” types that are stored as host objects and referenced by [Object] handle.

U64Object

Tag for a Val that refers to a host-side u64 number.

I64Object

Tag for a Val that refers to a host-side i64 number.

TimepointObject

Tag for a Val that refers to a host-side u64 number encoding a time-point (a count of seconds since the Unix epoch, Jan 1 1970 UTC).

DurationObject

Tag for a Val that refers to a host-side i64 number encoding a duration (a count of seconds).

U128Object

Tag for a Val that refers to a host-side u128 number.

I128Object

Tag for a Val that refers to a host-side i128 number.

U256Object

Tag for a Val that refers to a host-side [u256] number.

I256Object

Tag for a Val that refers to a host-side [i256] number.

BytesObject

StringObject

SymbolObject

VecObject

MapObject

AddressObject

ObjectCodeUpperBound

Bad

Implementations

impl Tag

pub const fn rawval_mask() -> i64

pub fn rawval_const(&self) -> i64

pub const fn is_object(self) -> bool

pub const fn from_u8(tag: u8) -> Tag

pub const fn get_scval_type(&self) -> Option<ScValType>

Get the ScValType of the XDR type that corresponds to this tag.

For use in the Host::obj_cmp comparison function so that comparison based on tags can be done identically to the ScVal type.

Returns None for Tag::Bad, and for the three marker tags SmallCodeUpperBound, ObjectCodeLowerBound, ObjectCodeUpperBound.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Hash for Tag

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

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 Tag

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

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

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

impl Eq for Tag

impl StructuralEq for Tag

impl StructuralPartialEq for Tag