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: Portfolio,
    pub log_guard: LogGuard,
    pub data_engine: Rc<RefCell<DataEngine>>,
    pub risk_engine: RiskEngine,
    pub exec_engine: ExecutionEngine,
    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: 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: RiskEngine

The risk engine instance.

exec_engine: ExecutionEngine

The execution engine instance.

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 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 msgbus(&self) -> Rc<RefCell<MessageBus>>

Returns the kernel’s message bus. // TODO: TBD if this is necessary

pub const fn portfolio(&self) -> &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) -> &RiskEngine

Returns the kernel’s risk engine.

pub const fn exec_engine(&self) -> &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 async fn stop_async(&mut self)

Stops the Nautilus system kernel.

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.

Trait Implementations

impl Debug for NautilusKernel

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

Formats the value using the given formatter.