Enum SpendableAmountError 

#[non_exhaustive]
pub enum SpendableAmountError {
    RoutingInfo(RoutingInfoError),
    FederationNotSupported,
    SelectGateway(SelectGatewayError),
    SendFeeExceedsLimit {
        fee: PaymentFee,
        limit: PaymentFee,
    },
    Quote(TransactionSubmitError),
    BalanceTooLow {
        balance: Amount,
    },
}

A failure to work out the largest invoice amount the client could pay in full.

The answer depends on a gateway’s fee schedule as well as on the balance, so it can be missing either because no schedule could be obtained or because the balance does not reach the smallest payable amount once both fees are applied.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RoutingInfo(RoutingInfoError)

The caller named a gateway and its routing information could not be fetched, so there is no fee schedule to compute against.

FederationNotSupported

The caller named a gateway and it answered, but it does not serve this federation.

SelectGateway(SelectGatewayError)

The caller named no gateway and none could be picked automatically, so there is no fee schedule to compute against.

SendFeeExceedsLimit

The gateway’s default send fee is above the limit this module accepts, so an amount computed against it would not be payable through it.

Fields

fee: PaymentFee

The default send fee the gateway announced.

limit: PaymentFee

The largest default send fee this module accepts.

Quote(TransactionSubmitError)

The fee probe failed for a reason unrelated to the balance.

BalanceTooLow

The balance cannot cover the smallest payable amount plus the gateway and federation fees, so there is no amount to send.

Fields

balance: Amount

The balance the answer was computed against.

Trait Implementations

impl Debug for SpendableAmountError

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

Formats the value using the given formatter.

impl Display for SpendableAmountError

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

Formats the value using the given formatter.

impl Error for SpendableAmountError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<RoutingInfoError> for SpendableAmountError

fn from(source: RoutingInfoError) -> Self

Converts to this type from the input type.

impl From<SelectGatewayError> for SpendableAmountError

fn from(source: SelectGatewayError) -> Self

Converts to this type from the input type.