Struct Vault 

pub struct Vault { /* private fields */ }

Implementations

impl Vault

pub fn new(slot_num: i32) -> Self

Binds this handle to a host-managed slot holding a Vault ledger object.

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vault

impl Debug for Vault

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

Formats the value using the given formatter.

impl Eq for Vault

impl LedgerObjectCommonFields for Vault

fn get_slot_num(&self) -> i32

Returns the slot number (register number) where the ledger object is stored.

fn path(&self) -> LedgerPathBuilder

Starts a nested-field path rooted at this ledger object, read through its slot.

fn get_flags(&self) -> Result<u32>

Retrieves the flags field of the ledger object.

fn get_ledger_entry_type(&self) -> Result<u16>

Retrieves the ledger entry type of the object.

impl PartialEq for Vault

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Vault

impl VaultFields for Vault

fn previous_txn_id(&self) -> Result<Hash256>

Identifies the transaction ID that most recently modified this object.

fn previous_txn_lgr_seq(&self) -> Result<u32>

The sequence of the ledger that contains the transaction that most recently modified this object.

fn sequence(&self) -> Result<u32>

The transaction sequence number that created the vault.

fn owner_node(&self) -> Result<u64>

Identifies the page where this item is referenced in the owner’s directory.

fn owner(&self) -> Result<AccountID>

The account address of the Vault Owner.

fn account(&self) -> Result<AccountID>

The address of the vault’s pseudo-account.

fn data(&self) -> Result<Option<StandardBlob>>

Arbitrary metadata, in hex format, about the vault. Limited to 256 bytes. See Data Field Format for more information.

fn asset(&self) -> Result<Issue>

The asset of the vault. The vault supports XRP, trust line tokens, and MPTs.

fn assets_total(&self) -> Result<Option<Number>>

The total value of the vault. Calculated as: assets available + assets on loan.

• Cash-basis vaults: Potential interest from scheduled, unpaid loans doesn’t count toward the total.
• Instant interest recognition vaults: Potential interest from scheduled, unpaid loans does count toward the total.

fn assets_available(&self) -> Result<Option<Number>>

The amount of assets available for loans and withdrawals.

fn assets_maximum(&self) -> Result<Option<Number>>

The maximum amount of assets that can be deposited into the vault. Set to 0 for no cap.

fn loss_unrealized(&self) -> Result<Option<Number>>

The potential loss amount that is not yet realized, expressed as the vault’s asset. Only a protocol connected to the vault can modify this attribute.

• Cash-basis vaults: Unrealized losses from interest aren’t included in this value.
• Instant interest recognition vaults: Unrealized losses from interest are included in this value.

fn share_mpt_id(&self) -> Result<Hash192>

The identifier of the share MPTokenIssuance object.

fn withdrawal_policy(&self) -> Result<u8>

Indicates the withdrawal strategy used by the vault.

fn scale(&self) -> Result<Option<u8>>

Specifies decimal precision for share calculations. Assets are multiplied by 10^Scale to convert fractional amounts into whole number shares. For example, with a Scale of 6, depositing 20.3 units creates 20,300,000 shares (20.3 × 10^Scale). For trust line tokens this can be configured at vault creation, and valid values are between 0-18, with the default being 6. For XRP and MPTs, this is fixed at 0. See Scaling Factor for more information.

fn le_version(&self) -> Result<Option<u8>>

Indicates what type of accounting the vault uses. 1 indicates the vault uses cash-basis accounting. If this field is omitted, the vault uses instant interest recognition accounting.

fn vault_kind(&self) -> Result<Option<u8>>

Indicates the kind of vault. 1 is a closed-ended vault. If this field is omitted, it’s an open-ended vault.

fn subscription_date(&self) -> Result<Option<u32>>

(Closed-ended vaults only) The time, in seconds since the Ripple Epoch, when the vault’s subscription window closes and its investment period begins.

fn redemption_date(&self) -> Result<Option<u32>>

(Closed-ended vaults only) The time, in seconds since the Ripple Epoch, when the vault’s investment period ends and depositors can redeem their shares.