Skip to main content

OrderBookImbalanceConfigBuilder

Struct OrderBookImbalanceConfigBuilder 

Source
pub struct OrderBookImbalanceConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> OrderBookImbalanceConfigBuilder<S>

Source

pub fn build(self) -> OrderBookImbalanceConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn base( self, value: StrategyConfig, ) -> OrderBookImbalanceConfigBuilder<SetBase<S>>
where S::Base: IsUnset,

Optional (Some / Option setters). Default:

StrategyConfig {
    strategy_id: Some(StrategyId::from("OrderBookImbalance-000")),
    order_id_tag: Some("000".to_string()),
    ..Default::default()
}

Base strategy configuration.

Source

pub fn maybe_base( self, value: Option<StrategyConfig>, ) -> OrderBookImbalanceConfigBuilder<SetBase<S>>
where S::Base: IsUnset,

Optional (Some / Option setters). Default:

StrategyConfig {
    strategy_id: Some(StrategyId::from("OrderBookImbalance-000")),
    order_id_tag: Some("000".to_string()),
    ..Default::default()
}

Base strategy configuration.

Source

pub fn instrument_id( self, value: InstrumentId, ) -> OrderBookImbalanceConfigBuilder<SetInstrumentId<S>>
where S::InstrumentId: IsUnset,

Required.

Instrument to subscribe to and trade.

Source

pub fn max_trade_size( self, value: Quantity, ) -> OrderBookImbalanceConfigBuilder<SetMaxTradeSize<S>>
where S::MaxTradeSize: IsUnset,

Required.

Maximum order size, truncated to the instrument’s size precision.

Source

pub fn trigger_min_size( self, value: Decimal, ) -> OrderBookImbalanceConfigBuilder<SetTriggerMinSize<S>>
where S::TriggerMinSize: IsUnset,

Optional (Some / Option setters). Default: Decimal::from(100).

The larger best size must exceed this threshold.

Source

pub fn maybe_trigger_min_size( self, value: Option<Decimal>, ) -> OrderBookImbalanceConfigBuilder<SetTriggerMinSize<S>>
where S::TriggerMinSize: IsUnset,

Optional (Some / Option setters). Default: Decimal::from(100).

The larger best size must exceed this threshold.

Source

pub fn trigger_imbalance_ratio( self, value: Decimal, ) -> OrderBookImbalanceConfigBuilder<SetTriggerImbalanceRatio<S>>
where S::TriggerImbalanceRatio: IsUnset,

Optional (Some / Option setters). Default: Decimal::new(20, 2).

The smaller/larger best-size ratio must be below this threshold in (0, 1).

Source

pub fn maybe_trigger_imbalance_ratio( self, value: Option<Decimal>, ) -> OrderBookImbalanceConfigBuilder<SetTriggerImbalanceRatio<S>>
where S::TriggerImbalanceRatio: IsUnset,

Optional (Some / Option setters). Default: Decimal::new(20, 2).

The smaller/larger best-size ratio must be below this threshold in (0, 1).

Source

pub fn min_seconds_between_triggers( self, value: f64, ) -> OrderBookImbalanceConfigBuilder<SetMinSecondsBetweenTriggers<S>>
where S::MinSecondsBetweenTriggers: IsUnset,

Optional (Some / Option setters). Default: 1.0.

Minimum elapsed seconds between eligible signals.

Source

pub fn maybe_min_seconds_between_triggers( self, value: Option<f64>, ) -> OrderBookImbalanceConfigBuilder<SetMinSecondsBetweenTriggers<S>>
where S::MinSecondsBetweenTriggers: IsUnset,

Optional (Some / Option setters). Default: 1.0.

Minimum elapsed seconds between eligible signals.

Source

pub fn book_type( self, value: BookType, ) -> OrderBookImbalanceConfigBuilder<SetBookType<S>>
where S::BookType: IsUnset,

Optional (Some / Option setters). Default: BookType::L2_MBP.

Book representation used by the managed subscription.

Source

pub fn maybe_book_type( self, value: Option<BookType>, ) -> OrderBookImbalanceConfigBuilder<SetBookType<S>>
where S::BookType: IsUnset,

Optional (Some / Option setters). Default: BookType::L2_MBP.

Book representation used by the managed subscription.

Source

pub fn time_in_force( self, value: TimeInForce, ) -> OrderBookImbalanceConfigBuilder<SetTimeInForce<S>>
where S::TimeInForce: IsUnset,

Optional (Some / Option setters). Default: TimeInForce::Fok.

Immediate execution policy: FOK requires a full fill; IOC permits partial fills.

Source

pub fn maybe_time_in_force( self, value: Option<TimeInForce>, ) -> OrderBookImbalanceConfigBuilder<SetTimeInForce<S>>
where S::TimeInForce: IsUnset,

Optional (Some / Option setters). Default: TimeInForce::Fok.

Immediate execution policy: FOK requires a full fill; IOC permits partial fills.

Source

pub fn log_interval( self, value: u64, ) -> OrderBookImbalanceConfigBuilder<SetLogInterval<S>>
where S::LogInterval: IsUnset,

Optional (Some / Option setters). Default: 0.

Snapshot logging interval in book updates, or zero to disable.

Source

pub fn maybe_log_interval( self, value: Option<u64>, ) -> OrderBookImbalanceConfigBuilder<SetLogInterval<S>>
where S::LogInterval: IsUnset,

Optional (Some / Option setters). Default: 0.

Snapshot logging interval in book updates, or zero to disable.

Source

pub fn dry_run( self, value: bool, ) -> OrderBookImbalanceConfigBuilder<SetDryRun<S>>
where S::DryRun: IsUnset,

Optional (Some / Option setters). Default: false.

Reports signals without submitting, canceling, or closing orders, including on stop.

Source

pub fn maybe_dry_run( self, value: Option<bool>, ) -> OrderBookImbalanceConfigBuilder<SetDryRun<S>>
where S::DryRun: IsUnset,

Optional (Some / Option setters). Default: false.

Reports signals without submitting, canceling, or closing orders, including on stop.

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> Ungil for T
where T: Send,

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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