Enum soroban_sdk::xdr::ScValType

#[repr(i32)]
pub enum ScValType {
    Bool = 0,
    Void = 1,
    Error = 2,
    U32 = 3,
    I32 = 4,
    U64 = 5,
    I64 = 6,
    Timepoint = 7,
    Duration = 8,
    U128 = 9,
    I128 = 10,
    U256 = 11,
    I256 = 12,
    Bytes = 13,
    String = 14,
    Symbol = 15,
    Vec = 16,
    Map = 17,
    Address = 18,
    ContractInstance = 19,
    LedgerKeyContractInstance = 20,
    LedgerKeyNonce = 21,
}

ScValType is an XDR Enum defines as:

enum SCValType
{
    SCV_BOOL = 0,
    SCV_VOID = 1,
    SCV_ERROR = 2,

    // 32 bits is the smallest type in WASM or XDR; no need for u8/u16.
    SCV_U32 = 3,
    SCV_I32 = 4,

    // 64 bits is naturally supported by both WASM and XDR also.
    SCV_U64 = 5,
    SCV_I64 = 6,

    // Time-related u64 subtypes with their own functions and formatting.
    SCV_TIMEPOINT = 7,
    SCV_DURATION = 8,

    // 128 bits is naturally supported by Rust and we use it for Soroban
    // fixed-point arithmetic prices / balances / similar "quantities". These
    // are represented in XDR as a pair of 2 u64s.
    SCV_U128 = 9,
    SCV_I128 = 10,

    // 256 bits is the size of sha256 output, ed25519 keys, and the EVM machine
    // word, so for interop use we include this even though it requires a small
    // amount of Rust guest and/or host library code.
    SCV_U256 = 11,
    SCV_I256 = 12,

    // Bytes come in 3 flavors, 2 of which have meaningfully different
    // formatting and validity-checking / domain-restriction.
    SCV_BYTES = 13,
    SCV_STRING = 14,
    SCV_SYMBOL = 15,

    // Vecs and maps are just polymorphic containers of other ScVals.
    SCV_VEC = 16,
    SCV_MAP = 17,

    // Address is the universal identifier for contracts and classic
    // accounts.
    SCV_ADDRESS = 18,

    // The following are the internal SCVal variants that are not
    // exposed to the contracts.
    SCV_CONTRACT_INSTANCE = 19,

    // SCV_LEDGER_KEY_CONTRACT_INSTANCE and SCV_LEDGER_KEY_NONCE are unique
    // symbolic SCVals used as the key for ledger entries for a contract's
    // instance and an address' nonce, respectively.
    SCV_LEDGER_KEY_CONTRACT_INSTANCE = 20,
    SCV_LEDGER_KEY_NONCE = 21
};

Variants

Bool = 0

Void = 1

Error = 2

U32 = 3

I32 = 4

U64 = 5

I64 = 6

Timepoint = 7

Duration = 8

U128 = 9

I128 = 10

U256 = 11

I256 = 12

Bytes = 13

String = 14

Symbol = 15

Vec = 16

Map = 17

Address = 18

ContractInstance = 19

LedgerKeyContractInstance = 20

LedgerKeyNonce = 21

Implementations

impl ScValType

pub const VARIANTS: [ScValType; 22] = _

pub const VARIANTS_STR: [&'static str; 22] = _

pub const fn name(&self) -> &'static str

pub const fn variants() -> [ScValType; 22]

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for ScValType

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<ScValType, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<ScValType, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for ScValType

fn clone(&self) -> ScValType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScValType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScValType

fn deserialize<__D>( __deserializer: __D ) -> Result<ScValType, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Discriminant<ScValType> for ScVal

fn discriminant(&self) -> ScValType

impl Display for ScValType

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

Formats the value using the given formatter.

impl Hash for ScValType

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 Name for ScValType

fn name(&self) -> &'static str

impl Ord for ScValType

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

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

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

fn read_xdr<R>(r: &mut Limited<R>) -> Result<ScValType, Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_base64<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Construct the type from the XDR bytes base64 encoded.

fn read_xdr_to_end<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Read the XDR and construct the type, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_base64_to_end<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Construct the type from the XDR bytes base64 encoded.

fn read_xdr_into<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_into_to_end<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR into the existing value, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_iter<R>(r: &mut Limited<R>) -> ReadXdrIter<&mut R, Self>

where R: Read,

Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.

fn read_xdr_base64_iter<R>( r: &mut Limited<R> ) -> ReadXdrIter<DecoderReader<'_, R>, Self>

where R: Read,

Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.

fn from_xdr(bytes: impl AsRef<[u8]>, limits: Limits) -> Result<Self, Error>

Construct the type from the XDR bytes.

fn from_xdr_base64(b64: impl AsRef<[u8]>, limits: Limits) -> Result<Self, Error>

Construct the type from the XDR bytes base64 encoded.

impl Serialize for ScValType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for ScValType

type Error = Error

The type returned in the event of a conversion error.

fn try_from(i: i32) -> Result<ScValType, Error>

Performs the conversion.

impl Variants<ScValType> for ScVal

fn variants() -> Iter<'static, ScValType>

impl Variants<ScValType> for ScValType

fn variants() -> Iter<'static, ScValType>

impl WriteXdr for ScValType

fn write_xdr<W>(&self, w: &mut Limited<W>) -> Result<(), Error>

where W: Write,

fn to_xdr(&self, limits: Limits) -> Result<Vec<u8>, Error>

fn to_xdr_base64(&self, limits: Limits) -> Result<String, Error>

impl Copy for ScValType

impl Enum for ScValType

impl Eq for ScValType

impl StructuralEq for ScValType

impl StructuralPartialEq for ScValType

impl Union<ScValType> for ScVal