Skip to main content

BracketOrderRequestBuilder

Struct BracketOrderRequestBuilder 

Source
pub struct BracketOrderRequestBuilder<ExchangeKey = ExchangeId, InstrumentKey = InstrumentNameExchange> { /* private fields */ }
Expand description

Builder for creating BracketOrderRequest with a fluent API.

§Example

use rustrade_execution::order::bracket::BracketOrderRequestBuilder;
use rustrade_execution::order::id::{ClientOrderId, StrategyId};
use rustrade_instrument::{Side, exchange::ExchangeId, instrument::name::InstrumentNameExchange};
use rust_decimal_macros::dec;

let instrument = InstrumentNameExchange::from("AAPL");
let request = BracketOrderRequestBuilder::new(
    ExchangeId::AlpacaBroker,
    &instrument,
    StrategyId::new("momentum"),
    ClientOrderId::new("bracket-001"),
)
.side(Side::Buy)
.quantity(dec!(10))
.entry_price(dec!(150.00))
.take_profit_price(dec!(160.00))
.stop_loss_price(dec!(145.00))
.build();

Implementations§

Source§

impl<ExchangeKey, InstrumentKey> BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: Clone, InstrumentKey: Clone,

Source

pub fn new( exchange: ExchangeKey, instrument: InstrumentKey, strategy: StrategyId, cid: ClientOrderId, ) -> Self

Create a new builder with the given order key components.

Source

pub fn side(self, side: Side) -> Self

Set the order side (Buy or Sell).

Source

pub fn quantity(self, quantity: Decimal) -> Self

Set the quantity for all legs.

Source

pub fn entry_price(self, price: Decimal) -> Self

Set the entry limit price.

Source

pub fn take_profit_price(self, price: Decimal) -> Self

Set the take-profit limit price.

Source

pub fn stop_loss_price(self, price: Decimal) -> Self

Set the stop-loss trigger price.

Source

pub fn stop_loss_limit_price(self, price: Decimal) -> Self

Set the stop-loss limit price (creates stop-limit SL on supporting exchanges).

Source

pub fn time_in_force(self, tif: TimeInForce) -> Self

Set the time-in-force for all legs.

Source

pub fn build(self) -> BracketOrderRequest<ExchangeKey, InstrumentKey>

Build the bracket order request.

§Panics

Panics if any required field is missing: side, quantity, entry_price, take_profit_price, or stop_loss_price.

Source

pub fn try_build( self, ) -> Option<BracketOrderRequest<ExchangeKey, InstrumentKey>>

Try to build the bracket order request, returning None if any required field is missing.

Trait Implementations§

Source§

impl<ExchangeKey: Clone, InstrumentKey: Clone> Clone for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>

Source§

fn clone(&self) -> BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<ExchangeKey: Debug, InstrumentKey: Debug> Debug for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<ExchangeKey, InstrumentKey> Freeze for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: Freeze, InstrumentKey: Freeze,

§

impl<ExchangeKey, InstrumentKey> RefUnwindSafe for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: RefUnwindSafe, InstrumentKey: RefUnwindSafe,

§

impl<ExchangeKey, InstrumentKey> Send for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: Send, InstrumentKey: Send,

§

impl<ExchangeKey, InstrumentKey> Sync for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: Sync, InstrumentKey: Sync,

§

impl<ExchangeKey, InstrumentKey> Unpin for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: Unpin, InstrumentKey: Unpin,

§

impl<ExchangeKey, InstrumentKey> UnsafeUnpin for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: UnsafeUnpin, InstrumentKey: UnsafeUnpin,

§

impl<ExchangeKey, InstrumentKey> UnwindSafe for BracketOrderRequestBuilder<ExchangeKey, InstrumentKey>
where ExchangeKey: UnwindSafe, InstrumentKey: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more