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
//! _🎵 Immutability never bothered me anyway 🎶_
//!
//! This crate provides various "Frozen" collections.
//!
//! These are append-only collections where references to entries can be held
//! on to even across insertions. This is safe because these collections only
//! support storing data that's present behind some indirection -- i.e. `String`,
//! `Vec<T>`, `Box<T>`, etc, and they only yield references to the data behind the
//! allocation (`&str`, `&[T]`, and `&T` respectively)
//!
//! The typical use case is having a global cache of strings or other data which the rest of the program borrows from.

pub mod map;
pub mod vec;

#[cfg(feature = "indexmap")]
pub mod index_map;
#[cfg(feature = "indexmap")]
pub mod index_set;

pub mod sync;

pub use map::{FrozenBTreeMap, FrozenMap};
pub use vec::FrozenVec;

#[cfg(feature = "indexmap")]
pub use index_map::FrozenIndexMap;
#[cfg(feature = "indexmap")]
pub use index_set::FrozenIndexSet;