Struct StrategyCore 

pub struct StrategyCore {
    pub config: StrategyConfig,
    /* private fields */
}

The core component of a Strategy, managing data, orders, and state.

This struct is intended to be held as a member within a user’s custom strategy struct. Use the nautilus_strategy! macro to provide the trait accessors required by Strategy, StrategyNative, and DataActor. It does not deref to [DataActorCore]; normal strategy logic should use facade methods on the strategy value.

Fields

config: StrategyConfig

The strategy configuration.

Implementations

impl StrategyCore

pub fn new_checked(config: StrategyConfig) -> CorrectnessResult<Self>

Creates a new StrategyCore instance with correctness checking.

Errors

Returns an error if the configured order ID tag contains the ‘-’ strategy ID separator, or if composing it into the strategy ID does not produce a valid [StrategyId].

pub fn new(config: StrategyConfig) -> Self

Creates a new StrategyCore instance.

Panics

Panics if the configured order ID tag contains the ‘-’ strategy ID separator, or if composing it into the strategy ID does not produce a valid [StrategyId].

pub fn config(&self) -> &StrategyConfig

Returns the strategy configuration.

pub fn change_id(&mut self, strategy_id: StrategyId) -> Result<()>

Changes the strategy ID before registration.

Errors

Returns an error if composing the current order ID tag into strategy_id does not produce a valid [StrategyId].

pub fn change_order_id_tag(&mut self, order_id_tag: &str) -> Result<()>

Changes the order ID tag before registration.

Errors

Returns an error if order_id_tag contains the ‘-’ strategy ID separator, or if composing it into the current strategy ID does not produce a valid [StrategyId].

pub fn order_id_tag(&self) -> Option<&str>

Returns the runtime order ID tag.

pub fn strategy_id(&self) -> Option<StrategyId>

Returns the runtime strategy ID.

pub fn register( &mut self, trader_id: TraderId, clock: Rc<RefCell<dyn Clock>>, cache: Rc<RefCell<Cache>>, portfolio: Rc<RefCell<Portfolio>>, ) -> Result<()>

Registers the strategy with the trading engine components.

This is typically called by the framework when the strategy is added to an engine.

Errors

Returns an error if the configured order ID tag contains the ‘-’ strategy ID separator, or if registration with the actor core fails.

pub fn order(&self) -> OrderApi<'_>

Returns the user-facing order creation API.

Panics

Panics if the strategy has not been registered.

pub fn reset_market_exit_state(&mut self)

Resets the market exit state.

Trait Implementations

impl DataActorNative for StrategyCore

fn core(&self) -> &DataActorCore

Returns the actor core.

fn core_mut(&mut self) -> &mut DataActorCore

Returns the mutable actor core.

fn clock_mut(&mut self) -> RefMut<'_, dyn Clock + 'static>

Returns the mutable clock borrow for the actor.

fn clock_rc(&self) -> Rc<RefCell<dyn Clock>>

Returns a clone of the reference-counted clock.

fn cache_ref(&self) -> Ref<'_, Cache>

Returns a read-only cache borrow.

fn cache_rc(&self) -> Rc<RefCell<Cache>>

Returns a clone of the reference-counted cache.

impl Debug for StrategyCore

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

Formats the value using the given formatter.

impl StrategyNative for StrategyCore

fn strategy_core(&self) -> &StrategyCore

Returns the strategy core.

fn strategy_core_mut(&mut self) -> &mut StrategyCore

Returns the mutable strategy core.

fn order_factory(&mut self) -> RefMut<'_, OrderFactory>

Returns a mutable borrow of the order factory.

fn order_factory_rc(&self) -> Rc<RefCell<OrderFactory>>

Returns a clone of the reference-counted order factory.

fn portfolio_rc(&self) -> Rc<RefCell<Portfolio>>

Returns a clone of the reference-counted portfolio.