nautilus-serialization 0.55.0

Serialization functionality for the Nautilus trading engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

//! Cap'n Proto serialization for Nautilus types.
//!
//! This module provides Cap'n Proto serialization support for Nautilus domain types.
//! The generated schema modules are available at the crate root for proper cross-referencing.
//!
//! # Generated Modules
//!
//! The following modules are generated from Cap'n Proto schemas:
//! - `crate::base_capnp` - Base types (UUID4, UnixNanos, StringMap)
//! - `crate::identifiers_capnp` - Identifier types
//! - `crate::types_capnp` - Value types (Price, Quantity, Money, etc.)
//! - `crate::enums_capnp` - Enumerations
//! - `crate::trading_capnp` - Trading commands
//! - `crate::data_capnp` - Data commands and responses
//! - `crate::order_capnp` - Order events
//! - `crate::position_capnp` - Position events
//! - `crate::account_capnp` - Account events
//! - `crate::market_capnp` - Market data types

pub mod conversions;

// Re-export generated modules for convenience.
// Re-export conversion functions for use by other crates
pub use conversions::order_side_to_capnp;

pub use crate::{
    account_capnp, base_capnp, data_capnp, enums_capnp, identifiers_capnp, market_capnp,
    order_capnp, position_capnp, trading_capnp, types_capnp,
};

/// Trait for converting Rust types to Cap'n Proto builders.
pub trait ToCapnp<'a> {
    /// The Cap'n Proto builder type for this Rust type.
    type Builder;

    /// Convert this Rust value to a Cap'n Proto builder.
    fn to_capnp(&self, builder: Self::Builder);
}

/// Trait for converting Cap'n Proto readers to Rust types.
pub trait FromCapnp<'a> {
    /// The Cap'n Proto reader type for this Rust type.
    type Reader;

    /// Convert a Cap'n Proto reader to this Rust type.
    ///
    /// # Errors
    ///
    /// Returns an error if the Cap'n Proto data is invalid or cannot be converted.
    fn from_capnp(reader: Self::Reader) -> Result<Self, Box<dyn std::error::Error>>
    where
        Self: Sized;
}