Struct Loan 

pub struct Loan { /* private fields */ }

Implementations

impl Loan

pub fn new(slot_num: i32) -> Self

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

Trait Implementations

impl Clone for Loan

fn clone(&self) -> Loan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Loan

impl Debug for Loan

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

Formats the value using the given formatter.

impl Eq for Loan

impl LedgerObjectCommonFields for Loan

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 LoanFields for Loan

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 owner_node(&self) -> Result<u64>

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

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

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

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

The ID of the Loan Broker associated with this loan.

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

The sequence number of the loan.

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

The account address of the Borrower.

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

The amount paid to the Loan Broker, taken from the principal loan at creation.

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

The amount paid to the Loan Broker with each loan payment.

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

The amount paid to the Loan Broker for each late payment.

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

The amount paid to the Loan Broker when a full early payment is made.

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

The fee charged on overpayments, in units of 1/10th basis points. Valid values are 0 to 100000 (inclusive), representing 0% to 100%.

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

The annualized interest rate of the loan, in 1/10th basis points.

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

The premium added to the interest rate for late payments, in units of 1/10th basis points. Valid values are 0 to 100000 (inclusive), representing 0% to 100%.

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

The interest rate charged for repaying the loan early, in units of 1/10th basis points. Valid values are 0 to 100000 (inclusive), representing 0% to 100%.

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

The interest rate charged on overpayments, in units of 1/10th basis points. Valid values are 0 to 100000 (inclusive), representing 0% to 100%.

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

The timestamp of when the loan started, in seconds since the Ripple Epoch.

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

The number of seconds between loan payments.

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

The number of seconds after a loan payment is due before the loan defaults.

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

The timestamp of when the previous payment was made, in seconds since the Ripple Epoch.

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

The timestamp of when the next payment is due, in seconds since the Ripple Epoch.

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

The number of payments remaining on the loan.

fn periodic_payment(&self) -> Result<Number>

The amount due for each payment interval.

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

The principal amount still owed on the loan.

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

The total amount owed on the loan, including remaining principal and fees.

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

The remaining management fee owed to the loan broker.

fn loan_scale(&self) -> Result<Option<i32>>

The scale factor that ensures all computed amounts are rounded to the same number of decimal places. It is based on the total loan value at creation time.

impl PartialEq for Loan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Loan