Skip to main content

LoanFields

Trait LoanFields 

Source
pub trait LoanFields: LedgerObjectCommonFields {
Show 27 methods // Provided methods fn previous_txn_id(&self) -> Result<Hash256> { ... } fn previous_txn_lgr_seq(&self) -> Result<u32> { ... } fn owner_node(&self) -> Result<u64> { ... } fn loan_broker_node(&self) -> Result<u64> { ... } fn loan_broker_id(&self) -> Result<Hash256> { ... } fn loan_sequence(&self) -> Result<u32> { ... } fn borrower(&self) -> Result<AccountID> { ... } fn loan_origination_fee(&self) -> Result<Option<Number>> { ... } fn loan_service_fee(&self) -> Result<Option<Number>> { ... } fn late_payment_fee(&self) -> Result<Option<Number>> { ... } fn close_payment_fee(&self) -> Result<Option<Number>> { ... } fn overpayment_fee(&self) -> Result<Option<u32>> { ... } fn interest_rate(&self) -> Result<Option<u32>> { ... } fn late_interest_rate(&self) -> Result<Option<u32>> { ... } fn close_interest_rate(&self) -> Result<Option<u32>> { ... } fn overpayment_interest_rate(&self) -> Result<Option<u32>> { ... } fn start_date(&self) -> Result<u32> { ... } fn payment_interval(&self) -> Result<u32> { ... } fn grace_period(&self) -> Result<Option<u32>> { ... } fn previous_payment_due_date(&self) -> Result<Option<u32>> { ... } fn next_payment_due_date(&self) -> Result<Option<u32>> { ... } fn payment_remaining(&self) -> Result<Option<u32>> { ... } fn periodic_payment(&self) -> Result<Number> { ... } fn principal_outstanding(&self) -> Result<Option<Number>> { ... } fn total_value_outstanding(&self) -> Result<Option<Number>> { ... } fn management_fee_outstanding(&self) -> Result<Option<Number>> { ... } fn loan_scale(&self) -> Result<Option<i32>> { ... }
}
Expand description

Trait providing access to fields specific to Loan objects in any ledger.

Provided Methods§

Source

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

Identifies the transaction ID that most recently modified this object.

Source

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

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

Source

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

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

Source

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

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

Source

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

The ID of the Loan Broker associated with this loan.

Source

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

The sequence number of the loan.

Source

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

The account address of the Borrower.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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%.

Source

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

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

Source

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%.

Source

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%.

Source

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%.

Source

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

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

Source

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

The number of seconds between loan payments.

Source

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

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

Source

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

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

Source

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

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

Source

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

The number of payments remaining on the loan.

Source

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

The amount due for each payment interval.

Source

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

The principal amount still owed on the loan.

Source

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

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

Source

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

The remaining management fee owed to the loan broker.

Source

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.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§