nautilus-plugin 0.67.0

Plug-in system 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

// -------------------------------------------------------------------------------------------------
//  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.
// -------------------------------------------------------------------------------------------------

//! Plug-in artifact identity and boundary primitives for
//! [NautilusTrader](https://nautilustrader.io).
//!
//! This crate provides the public contract that lets an independently compiled
//! Rust cdylib identify itself to a Nautilus host. It defines versioned build
//! metadata, allocator-safe boundary values, opaque host tokens, and the
//! `nautilus_plugin!` macro for exporting the standard entry symbol and
//! manifest.
//!
//! # Feature Flags
//!
//! This crate provides feature flags to control source code inclusion during compilation:
//!
//! - `component-binding`: Enables the experimental executable component contract.
//! - `host`: Optional plug-in manifest compatibility flag.

#![warn(clippy::pedantic)]
#![allow(
    clippy::manual_let_else,
    clippy::option_if_let_else,
    clippy::or_fun_call,
    clippy::redundant_else,
    clippy::similar_names,
    clippy::single_match_else,
    reason = "workspace policy; generated by scripts/update-clippy-allowances.py"
)]
#![allow(
    clippy::assert_is_empty,
    reason = "`assert!(x.is_empty())` is clearer than comparing against an empty value"
)]

/// ABI version of the public plug-in metadata contract.
///
/// The host refuses to load a plug-in whose
/// [`PluginManifest::abi_version`](crate::manifest::PluginManifest::abi_version)
/// does not match this value.
pub const NAUTILUS_PLUGIN_ABI_VERSION: u32 = 1;

/// Schema version for [`manifest::PluginBuildId`].
pub const PLUGIN_BUILD_ID_VERSION: u32 = 1;

/// Name of the single `extern "C"` entry symbol every plug-in cdylib exports.
pub const NAUTILUS_PLUGIN_INIT_SYMBOL: &[u8] = b"nautilus_plugin_init";

pub mod boundary;
#[cfg(feature = "component-binding")]
#[doc(hidden)]
pub mod component;
pub mod host;
pub mod manifest;
pub mod panic;

mod macros;

pub use boundary::{BorrowedStr, OwnedBytes, PluginError, PluginErrorCode, PluginResult, Slice};
pub use host::{HostContext, HostVTable};
pub use manifest::{PluginBuildId, PluginInitFn, PluginManifest};

/// Re-exports that plug-in crates typically want in scope.
pub mod prelude {
    pub use crate::{
        BorrowedStr, HostContext, HostVTable, NAUTILUS_PLUGIN_ABI_VERSION, PluginBuildId,
        PluginError, PluginErrorCode, PluginManifest, PluginResult, Slice,
    };
}

#[cfg(test)]
mod tests {
    use rstest::rstest;

    use super::*;

    #[rstest]
    fn init_symbol_matches_exported_entrypoint() {
        assert_eq!(NAUTILUS_PLUGIN_INIT_SYMBOL, b"nautilus_plugin_init");
    }
}