Struct BorrowCapacity 

#[non_exhaustive]
pub struct BorrowCapacity {
    pub asset: AssetNameExchange,
    pub borrowable_now: Option<Decimal>,
    pub account_limit: Option<Decimal>,
}

How much of an asset this account can borrow now, as the venue reported it.

Returned by BorrowCapacityClient::fetch_borrow_capacity. Both amounts are in units of asset, and None means the venue did not say, never zero.

Advisory

The values were true when the venue answered and are not reserved: a fill, a price move or another borrow can change them before an order arrives, so an order sized to them must still handle ApiError::BorrowRejected.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

asset: AssetNameExchange

The asset that would be borrowed: an instrument’s base asset for a sell, its quote asset for a buy.

borrowable_now: Option<Decimal>

How much more of asset this account can borrow now: what its collateral and its limit allow, less what it has already borrowed, and no more than the venue has to lend.

account_limit: Option<Decimal>

The most of asset the venue lets this account borrow in total, whatever its collateral. When borrowable_now is small, this says whether the account’s limit is why.

Implementations

impl BorrowCapacity

pub fn new(asset: AssetNameExchange) -> Self

The capacity to borrow asset, with nothing known.

pub fn with_borrowable_now(self, borrowable_now: Decimal) -> Self

With how much more of the asset this account can borrow now.

pub fn with_account_limit(self, account_limit: Decimal) -> Self

With the most of the asset the venue lets this account borrow in total.

Trait Implementations

impl Clone for BorrowCapacity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BorrowCapacity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BorrowCapacity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BorrowCapacity

impl Hash for BorrowCapacity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BorrowCapacity

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BorrowCapacity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BorrowCapacity