hamt_rs/lib.rs
1// Copyright (c) 2013, 2014, 2015, 2016 Michael Woerister
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE.
20
21//! This library contains some implementations of persistent data structures. Persistent
22//! data structures, also called purely functional data structures, are always immutable from the
23//! view of the user and can safely and easily be shared in a concurrent setting. For more
24//! information see [Wikipedia](https://en.wikipedia.org/wiki/Persistent_data_structure) for
25//! example.
26
27#![allow(unused_parens)]
28
29extern crate libc;
30
31extern crate rand;
32
33pub use hamt::HamtMap;
34pub use hamt::HamtMapIterator;
35pub use item_store::{ItemStore, ShareStore, CopyStore};
36
37mod hamt;
38mod item_store;
39
40#[cfg(test)]
41mod testing;