Struct NautilusKernel 

pub struct NautilusKernel {

    pub name: String,
    pub instance_id: UUID4,
    pub machine_id: String,
    pub config: Box<dyn NautilusKernelConfig>,
    pub cache: Rc<RefCell<Cache>>,
    pub clock: Rc<RefCell<dyn Clock>>,
    pub portfolio: Rc<RefCell<Portfolio>>,
    pub log_guard: LogGuard,
    pub data_engine: Rc<RefCell<DataEngine>>,
    pub risk_engine: Rc<RefCell<RiskEngine>>,
    pub exec_engine: Rc<RefCell<ExecutionEngine>>,
    pub order_emulator: OrderEmulatorAdapter,
    pub trader: Trader,
    pub ts_created: UnixNanos,
    pub ts_started: Option<UnixNanos>,
    pub ts_shutdown: Option<UnixNanos>,
}

Core Nautilus system kernel.

Orchestrates data and execution engines, cache, clock, and messaging across environments.

Fields

name: String

The kernel name (for logging and identification).

instance_id: UUID4

The unique instance identifier for this kernel.

machine_id: String

The machine identifier (hostname or similar).

config: Box<dyn NautilusKernelConfig>

The kernel configuration.

cache: Rc<RefCell<Cache>>

The shared in-memory cache.

clock: Rc<RefCell<dyn Clock>>

The clock driving the kernel.

portfolio: Rc<RefCell<Portfolio>>

The portfolio manager.

log_guard: LogGuard

Guard for the logging subsystem (keeps logger thread alive).

data_engine: Rc<RefCell<DataEngine>>

The data engine instance.

risk_engine: Rc<RefCell<RiskEngine>>

The risk engine instance.

exec_engine: Rc<RefCell<ExecutionEngine>>

The execution engine instance.

order_emulator: OrderEmulatorAdapter

The order emulator for handling emulated orders.

trader: Trader

The trader component.

ts_created: UnixNanos

The UNIX timestamp (nanoseconds) when the kernel was created.

ts_started: Option<UnixNanos>

The UNIX timestamp (nanoseconds) when the kernel was last started.

ts_shutdown: Option<UnixNanos>

The UNIX timestamp (nanoseconds) when the kernel was last shutdown.

Implementations

impl NautilusKernel

pub const fn builder( name: String, trader_id: TraderId, environment: Environment, ) -> NautilusKernelBuilder

Create a new NautilusKernelBuilder for fluent configuration.

pub fn new<T: NautilusKernelConfig + 'static>( name: String, config: T, ) -> Result<Self>

Create a new NautilusKernel instance.

Errors

Returns an error if the kernel fails to initialize.

pub fn generate_timestamp_ns(&self) -> UnixNanos

pub fn environment(&self) -> Environment

Returns the kernel’s environment context (Backtest, Sandbox, Live).

pub const fn name(&self) -> &str

Returns the kernel’s name.

pub fn trader_id(&self) -> TraderId

Returns the kernel’s trader ID.

pub fn machine_id(&self) -> &str

Returns the kernel’s machine ID.

pub const fn instance_id(&self) -> UUID4

Returns the kernel’s instance ID.

pub fn delay_post_stop(&self) -> Duration

Returns the delay after stopping the node to await residual events before final shutdown.

pub const fn ts_created(&self) -> UnixNanos

Returns the UNIX timestamp (ns) when the kernel was created.

pub const fn ts_started(&self) -> Option<UnixNanos>

Returns the UNIX timestamp (ns) when the kernel was last started.

pub const fn ts_shutdown(&self) -> Option<UnixNanos>

Returns the UNIX timestamp (ns) when the kernel was last shutdown.

pub fn load_state(&self) -> bool

Returns whether the kernel has been configured to load state.

pub fn save_state(&self) -> bool

Returns whether the kernel has been configured to save state.

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

Returns the kernel’s clock.

pub fn cache(&self) -> Rc<RefCell<Cache>>

Returns the kernel’s cache.

pub fn portfolio(&self) -> Ref<'_, Portfolio>

Returns the kernel’s portfolio.

pub fn data_engine(&self) -> Ref<'_, DataEngine>

Returns the kernel’s data engine.

pub const fn risk_engine(&self) -> &Rc<RefCell<RiskEngine>>

Returns the kernel’s risk engine.

pub const fn exec_engine(&self) -> &Rc<RefCell<ExecutionEngine>>

Returns the kernel’s execution engine.

pub const fn trader(&self) -> &Trader

Returns the kernel’s trader.

pub async fn start_async(&mut self)

Starts the Nautilus system kernel.

pub fn start_trader(&mut self)

Starts the trader (strategies and actors).

This should be called after clients are connected and instruments are cached.

pub fn stop_trader(&mut self)

Stops the trader and its registered components.

This method initiates a graceful shutdown of trading components (strategies, actors) which may trigger residual events such as order cancellations. The caller should continue processing events after calling this method to handle these residual events.

pub async fn finalize_stop(&mut self)

Finalizes the kernel shutdown after the grace period.

This method should be called after the residual events grace period has elapsed and all remaining events have been processed. It disconnects clients and stops engines.

pub fn reset(&mut self)

Resets the Nautilus system kernel to its initial state.

pub fn dispose(&mut self)

Disposes of the Nautilus system kernel, releasing resources.

pub async fn connect_clients(&mut self) -> Result<()>

Connects all engine clients.

Errors

Returns an error if any client fails to connect.

pub async fn disconnect_clients(&mut self) -> Result<()>

Disconnects all engine clients.

Errors

Returns an error if any client fails to disconnect.

pub fn check_engines_connected(&self) -> bool

Returns true if all engine clients are connected.

pub fn check_engines_disconnected(&self) -> bool

Returns true if all engine clients are disconnected.

Trait Implementations

impl Debug for NautilusKernel

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

Formats the value using the given formatter.