Skip to main content

LiveRiskEngineConfigBuilder

nautilus_live::config

Struct LiveRiskEngineConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> LiveRiskEngineConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn bypass(self, value: bool) -> LiveRiskEngineConfigBuilder<SetBypass<S>>
where S::Bypass: IsUnset,

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

If all pre-trade risk checks should be bypassed.

Source

pub fn maybe_bypass( self, value: Option<bool>, ) -> LiveRiskEngineConfigBuilder<SetBypass<S>>
where S::Bypass: IsUnset,

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

If all pre-trade risk checks should be bypassed.

Source

pub fn max_order_submit_rate( self, value: String, ) -> LiveRiskEngineConfigBuilder<SetMaxOrderSubmitRate<S>>
where S::MaxOrderSubmitRate: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_ORDER_RATE_LIMIT.to_string().

The maximum submit order rate as limit/HH:MM:SS.

Source

pub fn maybe_max_order_submit_rate( self, value: Option<String>, ) -> LiveRiskEngineConfigBuilder<SetMaxOrderSubmitRate<S>>
where S::MaxOrderSubmitRate: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_ORDER_RATE_LIMIT.to_string().

The maximum submit order rate as limit/HH:MM:SS.

Source

pub fn max_order_modify_rate( self, value: String, ) -> LiveRiskEngineConfigBuilder<SetMaxOrderModifyRate<S>>
where S::MaxOrderModifyRate: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_ORDER_RATE_LIMIT.to_string().

The maximum modify order rate as limit/HH:MM:SS.

Source

pub fn maybe_max_order_modify_rate( self, value: Option<String>, ) -> LiveRiskEngineConfigBuilder<SetMaxOrderModifyRate<S>>
where S::MaxOrderModifyRate: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_ORDER_RATE_LIMIT.to_string().

The maximum modify order rate as limit/HH:MM:SS.

Source

pub fn max_notional_per_order( self, value: HashMap<String, String>, ) -> LiveRiskEngineConfigBuilder<SetMaxNotionalPerOrder<S>>
where S::MaxNotionalPerOrder: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

The maximum notional per order keyed by instrument ID.

Entries map instrument ID strings to decimal notional strings.

Source

pub fn maybe_max_notional_per_order( self, value: Option<HashMap<String, String>>, ) -> LiveRiskEngineConfigBuilder<SetMaxNotionalPerOrder<S>>
where S::MaxNotionalPerOrder: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

The maximum notional per order keyed by instrument ID.

Entries map instrument ID strings to decimal notional strings.

Source

pub fn debug(self, value: bool) -> LiveRiskEngineConfigBuilder<SetDebug<S>>
where S::Debug: IsUnset,

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

If debug mode is active (will provide extra debug logging).

Source

pub fn maybe_debug( self, value: Option<bool>, ) -> LiveRiskEngineConfigBuilder<SetDebug<S>>
where S::Debug: IsUnset,

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

If debug mode is active (will provide extra debug logging).

Source

pub fn graceful_shutdown_on_error( self, value: bool, ) -> LiveRiskEngineConfigBuilder<SetGracefulShutdownOnError<S>>
where S::GracefulShutdownOnError: IsUnset,

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

If the engine should gracefully shut down when queue processing encounters unexpected errors.

Source

pub fn maybe_graceful_shutdown_on_error( self, value: Option<bool>, ) -> LiveRiskEngineConfigBuilder<SetGracefulShutdownOnError<S>>
where S::GracefulShutdownOnError: IsUnset,

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

If the engine should gracefully shut down when queue processing encounters unexpected errors.

Source

pub fn qsize(self, value: u32) -> LiveRiskEngineConfigBuilder<SetQsize<S>>
where S::Qsize: IsUnset,

Optional (Some / Option setters). Default: 100_000.

The queue size for the engine’s internal queue buffers.

Not implemented on the current live runtime; validate_runtime_support rejects any value other than the default.

Source

pub fn maybe_qsize( self, value: Option<u32>, ) -> LiveRiskEngineConfigBuilder<SetQsize<S>>
where S::Qsize: IsUnset,

Optional (Some / Option setters). Default: 100_000.

The queue size for the engine’s internal queue buffers.

Not implemented on the current live runtime; validate_runtime_support rejects any value other than the default.

Auto Trait Implementations§

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

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
§

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

§

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
§

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

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

§

fn vzip(self) -> V

§

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
§

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

§

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