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
93
94
95
96
97
98
pub use __finalize;
/// Attribute macro that expands a module or trait to break circular trait
/// obligations within the annotated module. Also see module-level documentation.
///
/// ```rust
/// # use decycle::decycle;
/// // This annotation is required to be used within #[decycle] module
/// #[decycle]
/// trait A {
/// fn a(&self) -> ::core::primitive::usize;
/// }
///
/// #[decycle]
/// mod cycle {
/// // Trait defined out of the module
/// #[decycle]
/// use super::A;
///
/// // Direct definition
/// #[decycle]
/// trait B {
/// fn b(&self) -> usize;
/// }
///
/// struct Left(usize);
/// struct Right(usize);
///
/// impl A for Left
/// where
/// Right: B,
/// {
/// fn a(&self) -> usize {
/// self.0 + 1
/// }
/// }
///
/// impl B for Right
/// where
/// Left: A,
/// {
/// fn b(&self) -> usize {
/// self.0 + 1
/// }
/// }
/// }
/// # fn main() {}
/// ```
///
/// ## Attribute Arguments
///
/// - **Module**:
/// - `#[decycle::decycle(recurse_level = N, support_infinite_cycle = true|false, decycle = path)]`
/// - `recurse_level`: expansion depth (default 10)
/// - `support_infinite_cycle`: enables/disable infinite cycle handling (default true)
/// - `decycle`: override the path used to refer to this crate
/// - **Trait** (defined out of `#[decycle]` module):
/// - `#[decycle::decycle(marker = path, decycle = path)]`
/// - `marker`: marker type used for internal references. Required when the
/// trait definition contains non-absolute type paths so decycle can intern
/// them into a stable, globally reachable form.
/// - `decycle`: override the path used to refer to this crate
///
///
/// ### Recursion limits
/// `recurse_level` limits how many expansion stages are used to break the cycle.
/// When the limit is reached:
/// - `support_infinite_cycle = true` switches to a runtime indirection that
/// caches function pointers to allow deeper cycles.
/// - `support_infinite_cycle = false` stops with `unimplemented!` in the
/// generated code.
/// - `support_infinite_cycle = false` removes runtime shim and it makes zero-cost abstraction
/// instead of the restriction of recursion limit.
///
/// ## Example with markers
/// Use `marker` when the trait contains non-absolute paths (e.g. `super::Type`,
/// `crate::Type`, or local aliases) so decycle can intern those references.
/// The path given with `marker = <path>` argument should be practically absolute and accessible from anywhere
/// where the defined trait is used.
///
/// ```rust
/// #[decycle::decycle(marker = Marker)]
/// trait MyTrait {
/// fn value(&self) -> i32;
/// }
/// struct Marker;
/// ```
pub use decycle;
/// Internal helper used by generated code to track staged type expansion.