Struct BorrowReject 

#[non_exhaustive]
pub struct BorrowReject {
    pub reason: BorrowRejectReason,
    pub venue_code: Option<String>,
    pub message: String,
    pub available: Option<Decimal>,
}

Why a venue refused to lend for an order, as carried by 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.

reason: BorrowRejectReason

The kind of refusal.

venue_code: Option<String>

The venue’s own code for the refusal, where it gave one (e.g. -3045 on Binance, 40310000 on Alpaca).

For diagnostics only, not a stable contract: match on reason instead. A venue may reuse a code for several refusals, as Alpaca’s generic 40310000 is.

message: String

The venue’s message. It may itself carry the code, as Binance’s does.

available: Option<Decimal>

How much more the venue could still have lent, in the units the order was sized in, where known: for a short sale, the most a smaller order could have sold short; for a spot margin sell, the most it could have borrowed, on top of whatever free base the account holds. Set by the simulated venue; no live client reports it yet.

Implementations

impl BorrowReject

pub fn new( reason: BorrowRejectReason, venue_code: Option<String>, message: String, ) -> Self

A refusal for reason, with the venue’s code where it gave one, and its message.

pub fn with_available(self, available: Decimal) -> Self

With how much the venue could still have lent.

Trait Implementations

impl Clone for BorrowReject

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 BorrowReject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BorrowReject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BorrowReject

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

Formats the value using the given formatter.

impl Eq for BorrowReject

impl Hash for BorrowReject

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 Ord for BorrowReject

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for BorrowReject

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BorrowReject

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BorrowReject

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 BorrowReject