Struct OrderRequestLeg 

pub struct OrderRequestLeg {
    pub instruction: OrderInstruction,
    pub quantity: Decimal,
    pub instrument: OrderRequestInstrument,
    pub position_effect: Option<PositionEffect>,
    pub quantity_type: Option<QuantityType>,
    pub div_cap_gains: Option<DivCapGains>,
    pub to_symbol: Option<String>,
}

Fields

instruction: OrderInstruction

quantity: Decimal

Shares or contracts; whole numbers for equities and options. For a mutual fund, denominated as quantity_type says. Sent as a JSON number.

instrument: OrderRequestInstrument

position_effect: Option<PositionEffect>

quantity_type: Option<QuantityType>

Mutual funds only: whether quantity is shares, dollars or the whole position.

div_cap_gains: Option<DivCapGains>

Mutual funds only: what happens to dividends and capital gains.

to_symbol: Option<String>

Mutual funds only: the fund an EXCHANGE moves into.

Implementations

impl OrderRequestLeg

pub fn new( instruction: OrderInstruction, instrument: OrderRequestInstrument, quantity: impl Into<Decimal>, ) -> Self

pub fn equity( instruction: OrderInstruction, symbol: impl Into<String>, quantity: impl Into<Decimal>, ) -> Self

pub fn option( instruction: OrderInstruction, symbol: impl Into<String>, quantity: impl Into<Decimal>, ) -> Self

quantity is in contracts.

pub fn with_position_effect(self, effect: PositionEffect) -> Self

impl OrderRequestLeg

pub fn validate(&self) -> Result<(), ValidationError>

The leg-level rules OrderRequest::validate applies to each leg.

Legs may be equities (and ETFs, which positions report as COLLECTIVE_INVESTMENT), options or mutual funds; other asset types are refused rather than sent unchecked.

Trait Implementations

impl Clone for OrderRequestLeg

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 OrderRequestLeg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderRequestLeg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for OrderRequestLeg

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 OrderRequestLeg

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OrderRequestLeg

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 OrderRequestLeg