Enum soroban_sdk::xdr::LedgerKey

pub enum LedgerKey {
    Account(LedgerKeyAccount),
    Trustline(LedgerKeyTrustLine),
    Offer(LedgerKeyOffer),
    Data(LedgerKeyData),
    ClaimableBalance(LedgerKeyClaimableBalance),
    LiquidityPool(LedgerKeyLiquidityPool),
    ContractData(LedgerKeyContractData),
    ContractCode(LedgerKeyContractCode),
    ConfigSetting(LedgerKeyConfigSetting),
    Ttl(LedgerKeyTtl),
}

LedgerKey is an XDR Union defines as:

union LedgerKey switch (LedgerEntryType type)
{
case ACCOUNT:
    struct
    {
        AccountID accountID;
    } account;

case TRUSTLINE:
    struct
    {
        AccountID accountID;
        TrustLineAsset asset;
    } trustLine;

case OFFER:
    struct
    {
        AccountID sellerID;
        int64 offerID;
    } offer;

case DATA:
    struct
    {
        AccountID accountID;
        string64 dataName;
    } data;

case CLAIMABLE_BALANCE:
    struct
    {
        ClaimableBalanceID balanceID;
    } claimableBalance;

case LIQUIDITY_POOL:
    struct
    {
        PoolID liquidityPoolID;
    } liquidityPool;
case CONTRACT_DATA:
    struct
    {
        SCAddress contract;
        SCVal key;
        ContractDataDurability durability;
    } contractData;
case CONTRACT_CODE:
    struct
    {
        Hash hash;
    } contractCode;
case CONFIG_SETTING:
    struct
    {
        ConfigSettingID configSettingID;
    } configSetting;
case TTL:
    struct
    {
        // Hash of the LedgerKey that is associated with this TTLEntry
        Hash keyHash;
    } ttl;
};

Variants

Account(LedgerKeyAccount)

Trustline(LedgerKeyTrustLine)

Offer(LedgerKeyOffer)

Data(LedgerKeyData)

ClaimableBalance(LedgerKeyClaimableBalance)

LiquidityPool(LedgerKeyLiquidityPool)

ContractData(LedgerKeyContractData)

ContractCode(LedgerKeyContractCode)

ConfigSetting(LedgerKeyConfigSetting)

Ttl(LedgerKeyTtl)

Implementations

impl LedgerKey

pub const VARIANTS: [LedgerEntryType; 10] = _

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

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

pub const fn discriminant(&self) -> LedgerEntryType

pub const fn variants() -> [LedgerEntryType; 10]

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for LedgerKey

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

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<LedgerKey, 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 LedgerKey

fn clone(&self) -> LedgerKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compare<LedgerKey> for Budget

type Error = HostError

fn compare( &self, a: &LedgerKey, b: &LedgerKey ) -> Result<Ordering, <Budget as Compare<LedgerKey>>::Error>

impl Debug for LedgerKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LedgerKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Discriminant<LedgerEntryType> for LedgerKey

fn discriminant(&self) -> LedgerEntryType

impl Hash for LedgerKey

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 LedgerKey

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

impl Ord for LedgerKey

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

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

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

fn read_xdr<R>(r: &mut Limited<R>) -> Result<LedgerKey, 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 LedgerKey

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 Variants<LedgerEntryType> for LedgerKey

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

impl WriteXdr for LedgerKey

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 Eq for LedgerKey

impl StructuralEq for LedgerKey

impl StructuralPartialEq for LedgerKey

impl Union<LedgerEntryType> for LedgerKey