Enum OrderSpec 

#[non_exhaustive]
pub enum OrderSpec {
    Market {
        leg: LegSpec,
        settings: OrderSettings,
    },
    Limit {
        leg: LegSpec,
        price: Decimal,
        settings: OrderSettings,
    },
    Stop {
        leg: LegSpec,
        stop_price: Decimal,
        settings: OrderSettings,
    },
    StopLimit {
        leg: LegSpec,
        stop_price: Decimal,
        price: Decimal,
        settings: OrderSettings,
    },
    TrailingStop {
        leg: LegSpec,
        basis: PriceLinkBasis,
        link: PriceLinkType,
        offset: Decimal,
        settings: OrderSettings,
    },
    NetDebit {
        legs: Vec<LegSpec>,
        price: Decimal,
        settings: OrderSettings,
    },
    NetCredit {
        legs: Vec<LegSpec>,
        price: Decimal,
        settings: OrderSettings,
    },
    NetZero {
        legs: Vec<LegSpec>,
        settings: OrderSettings,
    },
    Oco {
        first: Box<OrderSpec>,
        second: Box<OrderSpec>,
    },
    Trigger {
        entry: Box<OrderSpec>,
        children: Vec<OrderSpec>,
    },
    Bracket {
        entry: Box<OrderSpec>,
        take_profit: Decimal,
        stop_loss: Decimal,
    },
}

One order, keyed by kind. Single orders take a leg (or legs for the net-priced multi-leg kinds) and optional settings; oco, trigger and bracket nest other specs.

use rustyschwab_types::trading::{OrderSpec, OrderStrategyType};

let spec: OrderSpec = serde_json::from_value(serde_json::json!({
    "kind": "bracket",
    "entry": {
        "kind": "limit",
        "leg": {"instruction": "BUY", "quantity": "10",
                "instrument": {"asset_type": "EQUITY", "symbol": "AAPL"}},
        "price": "150.25",
        "settings": {"tag": "swing-1"}
    },
    "take_profit": "160",
    "stop_loss": "145"
}))
.unwrap();
let order = spec.build().unwrap();
assert_eq!(order.order_strategy_type, OrderStrategyType::Trigger);
assert_eq!(order.child_order_strategies[0].child_order_strategies.len(), 2);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Market

Fill at the market.

Fields

leg: LegSpec

settings: OrderSettings

Limit

Fill at price or better.

Fields

leg: LegSpec

price: Decimal

settings: OrderSettings

Stop

Become a market order once stop_price trades.

Fields

leg: LegSpec

stop_price: Decimal

settings: OrderSettings

StopLimit

Become a limit order at price once stop_price trades.

Fields

leg: LegSpec

stop_price: Decimal

price: Decimal

settings: OrderSettings

TrailingStop

A stop that trails basis by offset, expressed as link.

Fields

leg: LegSpec

basis: PriceLinkBasis

link: PriceLinkType

offset: Decimal

settings: OrderSettings

NetDebit

Multi-leg order paying at most price net.

Fields

legs: Vec<LegSpec>

price: Decimal

settings: OrderSettings

NetCredit

Multi-leg order collecting at least price net.

Fields

legs: Vec<LegSpec>

price: Decimal

settings: OrderSettings

NetZero

Multi-leg order that must fill for zero net cost.

Fields

legs: Vec<LegSpec>

settings: OrderSettings

Oco

Two orders; a fill on either cancels the other.

Fields

first: Box<OrderSpec>

second: Box<OrderSpec>

Trigger

children are submitted once entry fills.

Fields

entry: Box<OrderSpec>

children: Vec<OrderSpec>

Bracket

entry triggers a good-till-cancel take-profit limit and stop-loss pair that close the entry leg; see OrderRequest::bracket.

Fields

entry: Box<OrderSpec>

take_profit: Decimal

stop_loss: Decimal

Implementations

impl OrderSpec

pub fn build(self) -> Result<OrderRequest, String>

Expand into a validated OrderRequest.

Trait Implementations

impl Clone for OrderSpec

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 OrderSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OrderSpec

impl JsonSchema for OrderSpec

Available on crate feature schemars only.

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 OrderSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OrderSpec

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 OrderSpec

impl TryFrom<OrderSpec> for OrderRequest

type Error = String

The type returned in the event of a conversion error.

fn try_from(spec: OrderSpec) -> Result<Self, Self::Error>

Performs the conversion.