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
// -------------------------------------------------------------------------------------------------
// 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.
// -------------------------------------------------------------------------------------------------
//! Convenience macros for implementing actor boilerplate.
/// Wires an actor type's core field into the native runtime contract.
///
/// The struct must contain a field that provides a
/// [`DataActorCore`](crate::actor::DataActorCore) reference, either directly or
/// by deref coercion through an intermediate core type (e.g. `ExecutionAlgorithmCore`).
/// By default the macro expects the field to be named `core`; pass a second argument
/// to use a different name.
///
/// The generated native access implementation is runtime wiring. Normal actor code
/// should use [`DataActor`](crate::actor::DataActor) facade methods such as
/// `actor_id()`, `trader_id()`, `config()`, `clock()`, `cache()`, and the
/// subscription methods.
///
/// This macro only wires the data actor core. Components with a wider native
/// core, such as execution algorithms, keep their component-specific core
/// access behind their own native trait.
///
/// # Examples
///
/// ```ignore
/// use nautilus_common::{nautilus_actor, actor::DataActorCore};
///
/// pub struct MyActor {
/// core: DataActorCore,
/// // ...
/// }
///
/// nautilus_actor!(MyActor);
/// ```
///
/// With a custom field name:
///
/// ```ignore
/// pub struct MyActor {
/// actor_core: DataActorCore,
/// // ...
/// }
///
/// nautilus_actor!(MyActor, actor_core);
/// ```