Struct SField 

pub struct SField<T, const CODE: i32> { /* private fields */ }

A type-safe wrapper for XRPL serialized field codes.

This struct encodes both the field code and the expected type as const generics, allowing the compiler to automatically infer the correct type when calling get_field.

The type parameter T represents the expected Rust type for this field, which can be used with the field-decoder marker traits FromCurrentTx and FromLedger.

Example

use xrpl_common_stdlib::objects::ledger_object;
use xrpl_common_stdlib::current_tx;
use xrpl_common_stdlib::types::amount::Amount;
use xrpl_common_stdlib::sfield;
use xrpl_common_stdlib::types::account_id::AccountID;

// Type is automatically inferred from the SField constant, for both ledger_objects and current_transaction:
let flags:u32 = ledger_object::get_field(0, sfield::Flags).unwrap();  // u32
let balance:Amount = ledger_object::get_field(0, sfield::Balance).unwrap();  // u64
// current transaction:
let account:AccountID = current_tx::get_field(sfield::Account).unwrap();  // AccountID
let sequence:u32 = current_tx::get_field(sfield::Sequence).unwrap();  // u32

Implementations

impl<T, const CODE: i32> SField<T, CODE>

pub const fn new() -> Self

Creates a new SField constant.

This is a const function that can be used to initialize SField constants.

Trait Implementations

impl<T, const CODE: i32> Borrow<i32> for SField<T, CODE>

fn borrow(&self) -> &i32

Immutably borrows from an owned value.

impl<T: Clone, const CODE: i32> Clone for SField<T, CODE>

fn clone(&self) -> SField<T, CODE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy, const CODE: i32> Copy for SField<T, CODE>

impl<T: Debug, const CODE: i32> Debug for SField<T, CODE>

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

Formats the value using the given formatter.

impl<T, const CODE: i32> Default for SField<T, CODE>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq, const CODE: i32> Eq for SField<T, CODE>

impl<T, const CODE: i32> From<SField<T, CODE>> for i32

fn from(_: SField<T, CODE>) -> Self

Converts to this type from the input type.

impl<T: PartialEq, const CODE: i32> PartialEq for SField<T, CODE>

fn eq(&self, other: &SField<T, CODE>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq, const CODE: i32> StructuralPartialEq for SField<T, CODE>