Struct TransactionInstrument 

#[non_exhaustive]
pub struct TransactionInstrument {

    pub asset_type: AssetType,
    pub symbol: String,
    pub cusip: Option<String>,
    pub description: Option<String>,
    pub instrument_id: Option<i64>,
    pub net_change: Option<f64>,
    pub type_: Option<String>,
    pub status: Option<String>,
    pub closing_price: Option<f64>,
    pub expiration_date: Option<String>,
    pub put_call: Option<PutCall>,
    pub strike_price: Option<f64>,
    pub option_premium_multiplier: Option<i64>,
    pub underlying_symbol: Option<String>,
    pub underlying_cusip: Option<String>,
    pub maturity_date: Option<String>,
    pub factor: Option<f64>,
    pub variable_rate: Option<f64>,
    pub multiplier: Option<f64>,
    pub extra: HashMap<String, Value>,
}

The instrument on a TransferItem (TransactionInstrument in the Trader API spec). The base fields plus the option, fixed-income and future extensions are typed; the rest lands in extra.

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_type: AssetType

symbol: String

cusip: Option<String>

description: Option<String>

instrument_id: Option<i64>

net_change: Option<f64>

type_: Option<String>

Subtype whose value set depends on asset_type (COMMON_STOCK, SWEEP_VEHICLE, VANILLA, …).

status: Option<String>

Observed on live payloads (ACTIVE), undocumented in the spec.

closing_price: Option<f64>

Observed on live payloads, undocumented in the spec.

expiration_date: Option<String>

Options and futures.

put_call: Option<PutCall>

Options only. None when Schwab reports UNKNOWN.

strike_price: Option<f64>

Options only.

option_premium_multiplier: Option<i64>

Options only.

underlying_symbol: Option<String>

Options only.

underlying_cusip: Option<String>

Options only.

maturity_date: Option<String>

Fixed income only.

factor: Option<f64>

Fixed income only.

variable_rate: Option<f64>

Fixed income only.

multiplier: Option<f64>

Fixed income and futures.

extra: HashMap<String, Value>

Trait Implementations

impl Clone for TransactionInstrument

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 TransactionInstrument

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

Formats the value using the given formatter.

impl Default for TransactionInstrument

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransactionInstrument

where TransactionInstrument: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for TransactionInstrument

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for TransactionInstrument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TransactionInstrument

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 TransactionInstrument