Struct Shortability 

#[non_exhaustive]
pub struct Shortability {
    pub shortable: Option<bool>,
    pub easy_to_borrow: Option<bool>,
    pub available: Option<Decimal>,
    pub fee_rate: Option<Decimal>,
    pub delisting_at: Option<DateTime<Utc>>,
}

What a venue says about lending an instrument for a short sale.

Every field is optional, as no venue reports all of them: None means not known, never “no”. A consumer treats an unknown value as it sees fit; the simulated venue treats it as allowing the short.

Advisory

The values describe the venue’s lending as it reported it, not a promise to lend. A venue can still refuse a short its flags allow — Alpaca has refused “cannot be sold short” for an asset it flagged both shortable and easy to borrow — so a short sale 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.

shortable: Option<bool>

Whether the venue allows the instrument to be sold short at all.

easy_to_borrow: Option<bool>

Whether the venue lists the instrument as easy to borrow, rather than hard to borrow.

available: Option<Decimal>

How much the venue has to lend, in the units an order on the instrument is sized in: its total, not what is left after this account’s own shorts.

fee_rate: Option<Decimal>

The annualised fee for borrowing the instrument, as a fraction: 0.05 is 5% a year.

Simple, not compounded, and on the venue’s own year basis, which differs between venues: Alpaca divides its borrow rate over a 360-day year, and Binance’s hourly rate is annualised over 365 days. A simulated venue’s holding costs apply their own DayCount to whatever rate they are given.

delisting_at: Option<DateTime<Utc>>

When the venue has announced it will stop lending the instrument or trading it on margin.

A short still open then may be closed by the venue. A time already passed means the instrument is no longer shortable: a ShortabilityClient that reports one must also report shortable as Some(false), and the simulated venue refuses a short from this time on, whatever shortable says.

Implementations

impl Shortability

pub fn new() -> Self

Nothing known.

pub fn with_shortable(self, shortable: bool) -> Self

With whether the instrument may be sold short at all.

pub fn with_easy_to_borrow(self, easy_to_borrow: bool) -> Self

With whether the instrument is easy to borrow.

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

With how much the venue has to lend in total.

pub fn with_fee_rate(self, fee_rate: Decimal) -> Self

With the annualised borrow fee, as a fraction.

pub fn with_delisting_at(self, delisting_at: DateTime<Utc>) -> Self

With when the venue will stop lending the instrument or trading it on margin.

Trait Implementations

impl Clone for Shortability

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 Shortability

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

Formats the value using the given formatter.

impl Default for Shortability

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Shortability

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Shortability

impl Hash for Shortability

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 Shortability

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Shortability

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 Shortability