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

/// Interned string and more for rust.
///
/// # What is interning?
///
/// Interning is a method to store exactly one copy of immutable data.
///
/// Imagine your program holds lots of string values, mostly same value in it,
/// and does not mutate them at all. If you use `String` to store them,
/// lots of memories are wasted just for storing identical texts.
///
/// Interning efficiently eliminate this problem by managing global pool of cache,
/// in the case above the type of the pool can be `HashSet<Rc<str>>`.
/// When you need a new owned string, first you should lookup global pool for it.
/// If desired string is found then use it.
/// If not, just create a new one and put them also to the pool.
///
/// # What does this library provide?
///
/// This crate exposes `IStr` type correspond to `Rc<str>`
/// but guaranteed to be unique over its value within thread.
///
/// Additionally, `IStr` does not heap-allocate small strings that can be fit on
/// stack, typically up to 15 bytes on 64bit machine.
///
mod handle;
mod istr;
mod ibytes;
mod icstr;
mod iosstr;
mod ipath;

pub use istr::IStr;

// TODO: implement other types