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

//! Memory management utilities for Koto
//!
//! Currently, only reference-counted pointers without cycle detection are implemented.
//! The intent is that this crate can be expanded in the future with implementations of
//! `Ptr` and `PtrMut` that offer alternative memory management strategies.
//!
//! Making custom GC types that support trait objects or other DSTs is currently only
//! possible with nightly Rust, while the stabilization of DST custom coercions is pending [^1].
//! Until then, GC implementations for Ptr/PtrMut could be introduced with a nightly-only feature.
//!
//! [^1] <https://github.com/rust-lang/rust/issues/18598>

#![warn(missing_docs)]

#[cfg(all(feature = "arc", feature = "rc"))]
compile_error!("A single memory management feature can be enabled at a time");

mod address;
pub use address::Address;

#[cfg(feature = "arc")]
mod arc;
#[cfg(feature = "arc")]
pub use crate::arc::*;

#[cfg(feature = "rc")]
mod rc;
#[cfg(feature = "rc")]
pub use crate::rc::*;