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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #![cfg_attr(feature = "fatal-warnings", deny(warnings))] // Note: Keep this in sync with `README.md`. To do so run `./tools/update-readme.sh`. //! # Rust Persistent Data Structures //! //! Rust Persistent Data Structures provides [fully persistent data structures](https://en.wikipedia.org/wiki/Persistent_data_structure) //! with structural sharing. //! //! ## Setup //! //! To use rpds add the following to your `Cargo.toml`: //! //! ```toml //! [dependencies] //! rpds = "<version>" //! ``` //! //! Additionally, add this to your crate root: //! //! ```rust,ignore //! #[macro_use] //! extern crate rpds; //! ``` //! //! ### Enable serialization //! //! To enable serialization (using [serde](https://crates.io/crates/serde)) you need to enable the //! `serde` feature in rpds. To do so change the rpds dependency in `Cargo.toml` to //! //! ```toml //! [dependencies] //! rpds = { version = "<version>", features = ["serde"] } //! ``` //! //! ## Data Structures //! //! This crate implements the following data structures: //! //! 1. [`List`](#list) //! 2. [`Vector`](#vector) //! 3. [`Stack`](#stack) //! 4. [`Queue`](#queue) //! 5. [`HashTrieMap`](#hashtriemap) //! 6. [`HashTrieSet`](#hashtrieset) //! 7. [`RedBlackTreeMap`](#redblacktreemap) //! 8. [`RedBlackTreeSet`](#redblacktreeset) //! //! ### `List` //! [](sequence/list/struct.List.html) //! //! Your classic functional list. //! //! #### Example //! //! ```rust //! use rpds::List; //! //! let list = List::new().push_front("list"); //! //! assert_eq!(list.first(), Some(&"list")); //! //! let a_list = list.push_front("a"); //! //! assert_eq!(a_list.first(), Some(&"a")); //! //! let list_dropped = a_list.drop_first().unwrap(); //! //! assert_eq!(list_dropped, list); //! ``` //! //! ### `Vector` //! [](sequence/vector/struct.Vector.html) //! //! A sequence that can be indexed. The implementation is described in //! [Understanding Persistent Vector Part 1](http://hypirion.com/musings/understanding-persistent-vector-pt-1) //! and [Understanding Persistent Vector Part 2](http://hypirion.com/musings/understanding-persistent-vector-pt-2). //! //! #### Example //! //! ```rust //! use rpds::Vector; //! //! let vector = Vector::new() //! .push_back("I'm") //! .push_back("a") //! .push_back("vector"); //! //! assert_eq!(vector[1], "a"); //! //! let screaming_vector = vector //! .drop_last().unwrap() //! .push_back("VECTOR!!!"); //! //! assert_eq!(screaming_vector[2], "VECTOR!!!"); //! ``` //! //! ### `Stack` //! [](stack/struct.Stack.html) //! //! A LIFO (last in, first out) data structure. This is just a [`List`](#list) in disguise. //! //! #### Example //! //! ```rust //! use rpds::Stack; //! //! let stack = Stack::new().push("stack"); //! //! assert_eq!(stack.peek(), Some(&"stack")); //! //! let a_stack = stack.push("a"); //! //! assert_eq!(a_stack.peek(), Some(&"a")); //! //! let stack_popped = a_stack.pop().unwrap(); //! //! assert_eq!(stack_popped, stack); //! ``` //! //! ### `Queue` //! [](queue/struct.Queue.html) //! //! A FIFO (first in, first out) data structure. //! //! #### Example //! //! ```rust //! use rpds::Queue; //! //! let queue = Queue::new() //! .enqueue("um") //! .enqueue("dois") //! .enqueue("tres"); //! //! assert_eq!(queue.peek(), Some(&"um")); //! //! let queue_dequeued = queue.dequeue().unwrap(); //! //! assert_eq!(queue_dequeued.peek(), Some(&"dois")); //! ``` //! //! ### `HashTrieMap` //! [](map/hash_trie_map/struct.HashTrieMap.html) //! //! A map implemented with a [hash array mapped trie](https://en.wikipedia.org/wiki/Hash_array_mapped_trie). //! See [Ideal Hash Trees](https://infoscience.epfl.ch/record/64398/files/idealhashtrees.pdf) for //! details. //! //! #### Example //! //! ```rust //! use rpds::HashTrieMap; //! //! let map_en = HashTrieMap::new() //! .insert(0, "zero") //! .insert(1, "one"); //! //! assert_eq!(map_en.get(&1), Some(&"one")); //! //! let map_pt = map_en //! .insert(1, "um") //! .insert(2, "dois"); //! //! assert_eq!(map_pt.get(&2), Some(&"dois")); //! //! let map_pt_binary = map_pt.remove(&2); //! //! assert_eq!(map_pt_binary.get(&2), None); //! ``` //! //! ### `HashTrieSet` //! [](set/hash_trie_set/struct.HashTrieSet.html) //! //! A set implemented with a [`HashTrieMap`](#hashtriemap). //! //! #### Example //! //! ```rust //! use rpds::HashTrieSet; //! //! let set = HashTrieSet::new() //! .insert("zero") //! .insert("one"); //! //! assert!(set.contains(&"one")); //! //! let set_extended = set.insert("two"); //! //! assert!(set_extended.contains(&"two")); //! //! let set_positive = set_extended.remove(&"zero"); //! //! assert!(!set_positive.contains(&"zero")); //! ``` //! //! ### `RedBlackTreeMap` //! [](map/red_black_tree_map/struct.RedBlackTreeMap.html) //! //! A map implemented with a [red-black tree](https://en.wikipedia.org/wiki/Red-Black_tree). //! //! #### Example //! //! ```rust //! use rpds::RedBlackTreeMap; //! //! let map_en = RedBlackTreeMap::new() //! .insert(0, "zero") //! .insert(1, "one"); //! //! assert_eq!(map_en.get(&1), Some(&"one")); //! //! let map_pt = map_en //! .insert(1, "um") //! .insert(2, "dois"); //! //! assert_eq!(map_pt.get(&2), Some(&"dois")); //! //! let map_pt_binary = map_pt.remove(&2); //! //! assert_eq!(map_pt_binary.get(&2), None); //! //! assert_eq!(map_pt_binary.first(), Some((&0, &"zero"))); //! ``` //! //! ### `RedBlackTreeSet` //! [](set/red_black_tree_set/struct.RedBlackTreeSet.html) //! //! A set implemented with a [`RedBlackTreeMap`](#redblacktreemap). //! //! #### Example //! //! ```rust //! use rpds::RedBlackTreeSet; //! //! let set = RedBlackTreeSet::new() //! .insert("zero") //! .insert("one"); //! //! assert!(set.contains(&"one")); //! //! let set_extended = set.insert("two"); //! //! assert!(set_extended.contains(&"two")); //! //! let set_positive = set_extended.remove(&"zero"); //! //! assert!(!set_positive.contains(&"zero")); //! //! assert_eq!(set_positive.first(), Some(&"one")); //! ``` #[cfg(feature = "serde")] extern crate serde; #[cfg(test)] #[cfg(feature = "serde")] extern crate bincode; mod utils; pub mod sequence; pub mod stack; pub mod queue; pub mod map; pub mod set; pub use sequence::list::List; pub use sequence::vector::Vector; pub use stack::Stack; pub use queue::Queue; pub use map::hash_trie_map::HashTrieMap; pub use set::hash_trie_set::HashTrieSet; pub use map::red_black_tree_map::RedBlackTreeMap; pub use set::red_black_tree_set::RedBlackTreeSet;