Update Rust docs

Author: cjdsellers

nautilus_core/accounting/src/account/base.rs

@@ -44,6 +44,7 @@ pub struct BaseAccount {
 }
 
 impl BaseAccount {
+    /// Creates a new [`BaseAccount`] instance.
     pub fn new(event: AccountState, calculate_account_state: bool) -> anyhow::Result<Self> {
         let mut balances_starting: HashMap<Currency, Money> = HashMap::new();
         let mut balances: HashMap<Currency, AccountBalance> = HashMap::new();

nautilus_core/accounting/src/account/cash.rs

@@ -43,6 +43,7 @@ pub struct CashAccount {
 }
 
 impl CashAccount {
+    /// Creates a new [`CashAccount`] instance.
     pub fn new(event: AccountState, calculate_account_state: bool) -> anyhow::Result<Self> {
         Ok(Self {
             base: BaseAccount::new(event, calculate_account_state)?,

nautilus_core/accounting/src/account/margin.rs

@@ -54,6 +54,7 @@ pub struct MarginAccount {
 }
 
 impl MarginAccount {
+    /// Creates a new [`MarginAccount`] instance.
     pub fn new(event: AccountState, calculate_account_state: bool) -> anyhow::Result<Self> {
         Ok(Self {
             base: BaseAccount::new(event, calculate_account_state)?,

nautilus_core/adapters/src/databento/live.rs

@@ -83,7 +83,7 @@ pub struct DatabentoFeedHandler {
 }
 
 impl DatabentoFeedHandler {
-    /// Initialize a new instance of the [`DatabentoFeedHandler`].
+    /// Creates a new [`DatabentoFeedHandler`] instance.
     #[must_use]
     pub fn new(
         key: String,

nautilus_core/adapters/src/databento/loader.rs

@@ -68,6 +68,7 @@ pub struct DatabentoDataLoader {
 }
 
 impl DatabentoDataLoader {
+    /// Creates a new [`DatabentoDataLoader`] instance.
     pub fn new(path: Option<PathBuf>) -> anyhow::Result<Self> {
         let mut loader = Self {
             publishers_map: IndexMap::new(),

nautilus_core/adapters/src/databento/types.rs

@@ -85,6 +85,7 @@ pub struct DatabentoImbalance {
 }
 
 impl DatabentoImbalance {
+    /// Creates a new [`DatabentoImbalance`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         instrument_id: InstrumentId,
@@ -154,6 +155,7 @@ pub struct DatabentoStatistics {
 }
 
 impl DatabentoStatistics {
+    /// Creates a new [`DatabentoStatistics`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         instrument_id: InstrumentId,

nautilus_core/backtest/src/engine.rs

@@ -29,7 +29,7 @@ pub struct TimeEventAccumulator {
 }
 
 impl TimeEventAccumulator {
-    /// Creates a new `TimeEventAccumulator` instance.
+    /// Creates a new [`TimeEventAccumulator`] instance.
     #[must_use]
     pub fn new() -> Self {
         Self {
@@ -55,6 +55,7 @@ impl TimeEventAccumulator {
 }
 
 impl Default for TimeEventAccumulator {
+    /// Creates a new default [`TimeEventAccumulator`] instance.
     fn default() -> Self {
         Self::new()
     }

nautilus_core/backtest/src/matching_engine.rs

@@ -91,8 +91,9 @@ pub struct OrderMatchingEngine {
     execution_count: usize,
 }
 
-// Note: we'll probably be changing the `FillModel` (don't add for now)
+// TODO: we'll probably be changing the `FillModel` (don't add for now)
 impl OrderMatchingEngine {
+    /// Creates a new [`OrderMatchingEngine`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         instrument: Box<dyn Instrument>,

nautilus_core/common/src/cache/core.rs

@@ -64,6 +64,7 @@ pub struct CacheConfig {
 }
 
 impl CacheConfig {
+    /// Creates a new [`CacheConfig`] instance.
     #[allow(clippy::too_many_arguments)]
     #[must_use]
     pub fn new(
@@ -90,7 +91,7 @@ impl CacheConfig {
 }
 
 impl Default for CacheConfig {
-    /// Creates a new default `CacheConfig` instance.
+    /// Creates a new default [`CacheConfig`] instance.
     fn default() -> Self {
         Self::new(
             SerializationEncoding::MsgPack,
@@ -192,14 +193,14 @@ pub struct Cache {
 }
 
 impl Default for Cache {
-    /// Creates a new default `Cache` instance.
+    /// Creates a new default [`Cache`] instance.
     fn default() -> Self {
         Self::new(CacheConfig::default(), None)
     }
 }
 
 impl Cache {
-    /// Creates a new `Cache` instance.
+    /// Creates a new [`Cache`] instance.
     #[must_use]
     pub fn new(config: CacheConfig, database: Option<CacheDatabaseAdapter>) -> Self {
         let index = CacheIndex {

nautilus_core/common/src/cache/database.rs

@@ -58,6 +58,7 @@ pub struct DatabaseCommand {
 }
 
 impl DatabaseCommand {
+    /// Creates a new [`DatabaseCommand`] instance.
     #[must_use]
     pub fn new(op_type: DatabaseOperation, key: String, payload: Option<Vec<Vec<u8>>>) -> Self {
         Self {

nautilus_core/common/src/clock.rs

@@ -82,6 +82,7 @@ pub struct TestClock {
 }
 
 impl TestClock {
+    /// Creates a new [`TestClock`] instance.
     #[must_use]
     pub fn new() -> Self {
         Self {
@@ -152,6 +153,7 @@ fn create_time_event_handler(event: TimeEvent, handler: &EventHandler) -> TimeEv
 }
 
 impl Default for TestClock {
+    /// Creates a new default [`TestClock`] instance.
     fn default() -> Self {
         Self::new()
     }
@@ -274,6 +276,7 @@ pub struct LiveClock {
 }
 
 impl LiveClock {
+    /// Creates a new [`LiveClock`] instance.
     #[must_use]
     pub fn new() -> Self {
         Self {
@@ -290,6 +293,7 @@ impl LiveClock {
 }
 
 impl Default for LiveClock {
+    /// Creates a new default [`LiveClock`] instance.
     fn default() -> Self {
         Self::new()
     }

nautilus_core/common/src/factories.rs

@@ -44,6 +44,7 @@ pub struct OrderFactory {
 }
 
 impl OrderFactory {
+    /// Creates a new [`OrderFactory`] instance.
     pub fn new(
         trader_id: TraderId,
         strategy_id: StrategyId,

nautilus_core/common/src/generators/client_order_id.rs

@@ -29,6 +29,7 @@ pub struct ClientOrderIdGenerator {
 }
 
 impl ClientOrderIdGenerator {
+    /// Creates a new [`ClientOrderIdGenerator`] instance.
     #[must_use]
     pub fn new(
         trader_id: TraderId,

nautilus_core/common/src/generators/order_list_id.rs

@@ -29,6 +29,7 @@ pub struct OrderListIdGenerator {
 }
 
 impl OrderListIdGenerator {
+    /// Creates a new [`OrderListIdGenerator`] instance.
     #[must_use]
     pub fn new(
         trader_id: TraderId,

nautilus_core/common/src/generators/position_id.rs

@@ -30,6 +30,7 @@ pub struct PositionIdGenerator {
 }
 
 impl PositionIdGenerator {
+    /// Creates a new [`PositionIdGenerator`] instance.
     #[must_use]
     pub fn new(trader_id: TraderId, clock: &'static AtomicTime) -> Self {
         Self {

nautilus_core/common/src/logging/logger.rs

@@ -64,6 +64,7 @@ pub struct LoggerConfig {
 }
 
 impl Default for LoggerConfig {
+    /// Creates a new default [`LoggerConfig`] instance.
     fn default() -> Self {
         Self {
             stdout_level: LevelFilter::Info,
@@ -76,6 +77,7 @@ impl Default for LoggerConfig {
 }
 
 impl LoggerConfig {
+    /// Creates a new [`LoggerConfig`] instance.
     #[must_use]
     pub fn new(
         stdout_level: LevelFilter,
@@ -194,6 +196,7 @@ pub struct LogLineWrapper {
 }
 
 impl LogLineWrapper {
+    /// Creates a new [`LogLineWrapper`] instance.
     #[must_use]
     pub fn new(line: LogLine, trader_id: Ustr, timestamp: UnixNanos) -> Self {
         Self {
@@ -479,13 +482,15 @@ pub struct LogGuard {
 }
 
 impl LogGuard {
+    /// Creates a new [`LogGuard`] instance.
     #[must_use]
     pub fn new(handle: Option<JoinHandle<()>>) -> Self {
         Self { handle }
     }
 }
 
 impl Default for LogGuard {
+    /// Creates a new default [`LogGuard`] instance.
     fn default() -> Self {
         Self::new(None)
     }

nautilus_core/common/src/logging/writer.rs

@@ -42,6 +42,7 @@ pub struct StdoutWriter {
 }
 
 impl StdoutWriter {
+    /// Creates a new [`StdoutWriter`] instance.
     #[must_use]
     pub fn new(level: LevelFilter, is_colored: bool) -> Self {
         Self {
@@ -80,6 +81,7 @@ pub struct StderrWriter {
 }
 
 impl StderrWriter {
+    /// Creates a new [`StderrWriter`] instance.
     #[must_use]
     pub fn new(is_colored: bool) -> Self {
         Self {
@@ -121,6 +123,7 @@ pub struct FileWriterConfig {
 }
 
 impl FileWriterConfig {
+    /// Creates a new [`FileWriterConfig`] instance.
     #[must_use]
     pub fn new(
         directory: Option<String>,
@@ -147,6 +150,7 @@ pub struct FileWriter {
 }
 
 impl FileWriter {
+    /// Creates a new [`FileWriter`] instance.
     pub fn new(
         trader_id: String,
         instance_id: String,

nautilus_core/common/src/msgbus/core.rs

@@ -43,6 +43,7 @@ pub struct Subscription {
 }
 
 impl Subscription {
+    /// Creates a new [`Subscription`] instance.
     #[must_use]
     pub fn new(
         topic: Ustr,
@@ -165,7 +166,7 @@ pub struct MessageBus {
 }
 
 impl MessageBus {
-    /// Creates a new `MessageBus` instance.
+    /// Creates a new [`MessageBus`] instance.
     pub fn new(
         trader_id: TraderId,
         instance_id: UUID4,

nautilus_core/common/src/timer.rs

@@ -59,8 +59,10 @@ pub struct TimeEvent {
     pub ts_init: UnixNanos,
 }
 
-/// Assumes `name` is a valid string.
 impl TimeEvent {
+    /// Creates a new [`TimeEvent`] instance.
+    ///
+    /// Assumes `name` is a valid string.
     #[must_use]
     pub fn new(name: Ustr, event_id: UUID4, ts_event: UnixNanos, ts_init: UnixNanos) -> Self {
         Self {
@@ -92,7 +94,7 @@ impl PartialEq for TimeEvent {
 #[derive(Clone, Debug)]
 /// Represents a time event and its associated handler.
 pub struct TimeEventHandler {
-    /// The event.
+    /// The time event.
     pub event: TimeEvent,
     /// The callable raw pointer.
     pub callback_ptr: *mut c_char,
@@ -130,7 +132,7 @@ pub struct TestTimer {
 }
 
 impl TestTimer {
-    /// Creates a new `TestTimer` instance.
+    /// Creates a new [`TestTimer`] instance.
     pub fn new(
         name: &str,
         interval_ns: u64,
@@ -233,7 +235,7 @@ pub struct LiveTimer {
 }
 
 impl LiveTimer {
-    /// Creates a new `LiveTimer` instance.
+    /// Creates a new [`LiveTimer`] instance.
     pub fn new(
         name: &str,
         interval_ns: u64,

nautilus_core/core/src/time.rs

@@ -85,13 +85,17 @@ impl Deref for AtomicTime {
 }
 
 impl Default for AtomicTime {
+    /// Creates a new default [`AtomicTime`] instance.
     fn default() -> Self {
         Self::new(true, UnixNanos::default())
     }
 }
 
 impl AtomicTime {
-    /// New atomic clock set with the given UNIX time (nanoseconds).
+    /// Creates a new [`AtomicTime`] instance.
+    ///
+    /// The `realtime` flag will determine whether the atomic time is based off system time.
+    /// The time will be set to the given UNIX `time` (nanoseconds).
     #[must_use]
     pub fn new(realtime: bool, time: UnixNanos) -> Self {
         Self {

nautilus_core/core/src/uuid.rs

@@ -43,7 +43,7 @@ pub struct UUID4 {
 }
 
 impl UUID4 {
-    /// Creates a new `UUID4` instance.
+    /// Creates a new [`UUID4`] instance.
     #[must_use]
     pub fn new() -> Self {
         let uuid = Uuid::new_v4();
@@ -84,6 +84,7 @@ impl From<&str> for UUID4 {
 }
 
 impl Default for UUID4 {
+    /// Creates a new default [`UUID4`] instance.
     fn default() -> Self {
         Self::new()
     }

nautilus_core/execution/src/matching_core.rs

@@ -51,6 +51,7 @@ pub struct OrderMatchingCore {
 }
 
 impl OrderMatchingCore {
+    // Creates a new [`OrderMatchingCore`] instance.
     #[must_use]
     pub fn new(
         instrument_id: InstrumentId,

nautilus_core/execution/src/messages/cancel.rs

@@ -38,6 +38,7 @@ pub struct CancelOrder {
 }
 
 impl CancelOrder {
+    /// Creates a new [`CancelOrder`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         trader_id: TraderId,

nautilus_core/execution/src/messages/cancel_all.rs

@@ -40,6 +40,7 @@ pub struct CancelAllOrders {
 }
 
 impl CancelAllOrders {
+    /// Creates a new [`CancelAllOrders`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         trader_id: TraderId,

nautilus_core/execution/src/messages/cancel_batch.rs

@@ -38,6 +38,7 @@ pub struct BatchCancelOrders {
 }
 
 impl BatchCancelOrders {
+    /// Creates a new [`BatchCancelOrders`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         trader_id: TraderId,

nautilus_core/execution/src/messages/modify.rs

@@ -44,6 +44,7 @@ pub struct ModifyOrder {
 }
 
 impl ModifyOrder {
+    /// Creates a new [`ModifyOrder`] instance.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         trader_id: TraderId,