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
//! The `typed-index-collections` crate provides [`TiSlice`] and [`TiVec`] structs //! that are typed index versions of the Rust [`slice`] and [`std::vec::Vec`] types. //! //! # Introduction //! //! The extensive use of slices and vectors instead of references //! and smart pointers might be useful for optimization, //! Data-Oriented Design and when using Struct of Arrays. //! But when dealing with a bunch of slices and vectors //! it is easy to accidentally use the wrong index, //! which is a common source of bugs. //! //! # About //! //! This crate provides [`TiSlice<K, V>`][`TiSlice`] and [`TiVec<K, V>`][`TiVec`] containers //! that can be indexed only by the specified index type `K`. //! These containers are only wrappers around //! the slice primitive [`[V]`][`slice`] and the container [`std::vec::Vec<V>`][`std::vec::Vec`]. //! Crate containers mirror the stable API of the matched Rust containers //! and forward to them as much as possible. //! //! [`TiSlice`] and [`TiVec`] can be easily converted to matched Rust containers and back using //! [`From`], [`Into`], [`AsRef`] and [`AsMut`] traits. //! Also, they expose `raw` property with the original data type. //! Containers only require the index to implement //! [`From<usize>`][`From`] and [`Into<usize>`][`Into`] traits //! that can be easily done with [`derive_more`] crate and `#[derive(From, Into)]`. //! //! # Usage //! //! First, add the following to your `Cargo.toml`: //! //! ```toml //! [dependencies] //! typed-index-collections = "3.0" //! ``` //! //! This crate depends on the standard library by default that is useful //! for debugging and for some extra functionality. //! To use this crate in a `#![no_std]` context, use `default-features = false` //! in your `Cargo.toml` as shown below: //! //! ```toml //! [dependencies.typed-index-collections] //! version = "3.0" //! default-features = false //! features = ["alloc"] //! ``` //! //! If you want to use [`derive_more`] for //! [`From<usize>`][`From`] and [`Into<usize>`][`Into`] implementation //! add it to your `Cargo.toml` as shown below: //! //! ```toml //! [dependencies] //! derive_more = "0.99" //! typed-index-collections = "3.0" //! ``` //! //! # Examples //! //! Simple example with [`derive_more`]: #![cfg_attr(any(feature = "alloc", feature = "std"), doc = "```rust")] #![cfg_attr( not(any(feature = "alloc", feature = "std")), doc = "```rust,compile_fail" )] //!use typed_index_collections::TiVec; //!use derive_more::{From, Into}; //! //!#[derive(From, Into)] //!struct FooId(usize); //! //!let mut ti_vec: TiVec<FooId, usize> = std::vec![10, 11, 13].into(); //!ti_vec.insert(FooId(2), 12); //!assert_eq!(ti_vec[FooId(2)], 12); //!``` //! //! If a wrong index type is used, compilation will fail: //!```compile_fail //!use typed_index_collections::TiVec; //!use derive_more::{From, Into}; //! //!#[derive(From, Into)] //!struct FooId(usize); //! //!#[derive(From, Into)] //!struct BarId(usize); //! //!let mut ti_vec: TiVec<FooId, usize> = std::vec![10, 11, 13].into(); //! //!ti_vec.insert(BarId(2), 12); //!// ^^^^^^^^ expected struct `FooId`, found struct `BarId` //!assert_eq!(ti_vec[BarId(2)], 12); //!// ^^^^^^^^^^^^^^^^ the trait ... is not implemented for `BarId` //! ``` //! //! Another more detailed example with [`derive_more`]: #![cfg_attr(any(feature = "alloc", feature = "std"), doc = "```rust")] #![cfg_attr( not(any(feature = "alloc", feature = "std")), doc = "```rust,compile_fail" )] //!use typed_index_collections::{TiSlice, TiVec}; //!use derive_more::{From, Into}; //! //!#[derive(Clone, Copy, Debug, From, Into, Eq, PartialEq)] //!struct FooId(usize); //! //!#[derive(Clone, Copy, Debug, Eq, PartialEq)] //!struct Foo { //! value: usize, //!} //! //!let first = Foo { value: 1 }; //!let second = Foo { value: 2 }; //! //!let slice_ref = &[first, second][..]; //!let vec = std::vec![first, second]; //!let boxed_slice = std::vec![first, second].into_boxed_slice(); //! //!let ti_slice_ref: &TiSlice<FooId, Foo> = slice_ref.as_ref(); //!let ti_vec: TiVec<FooId, Foo> = vec.into(); //!let ti_boxed_slice: std::boxed::Box<TiSlice<FooId, Foo>> = boxed_slice.into(); //! //!assert_eq!(ti_vec[FooId(1)], second); //!assert_eq!(ti_vec.raw[1], second); //!assert_eq!(ti_vec.last(), Some(&second)); //!assert_eq!(ti_vec.last_key_value(), Some((FooId(1), &second))); //!assert_eq!(ti_vec.iter_enumerated().next(), Some((FooId(0), &first))); //! //!let _slice_ref: &[Foo] = ti_slice_ref.as_ref(); //!let _vec: std::vec::Vec<Foo> = ti_vec.into(); //!let _boxed_slice: std::boxed::Box<[Foo]> = ti_boxed_slice.into(); //!``` //! //! # Feature Flags //! //! - `alloc` (enabled by default): Enables types and functions //! which require memory allocation. //! - `std` (enabled by default): Enables all [`std`] features //! such as memory allocations, [`std::error::Error`] trait and //! [`std::panic::UnwindSafe`] trait implementations. //! - `serde`: Implements [`Serialize`] trait for [`TiSlice`] and [`TiVec`] containers. //! - `serde-alloc`: Enables [`alloc`] and `serde/alloc` features and //! implements [`Deserialize`] trait for [`Box`]`<`[`TiSlice`]`>` and [`TiVec`]. //! - `serde-std`: Enables [`std`] and `serde/std` features and //! implements [`Deserialize`] trait for [`Box`]`<`[`TiSlice`]`>` and [`TiVec`]. //! //! # Similar crates //! //! - [`typed_index_collection`] provides a `Vec` wrapper with a very limited API. //! Indices are u32 wrappers, //! they are not customizable and can only index a specific type of container. //! - [`indexed_vec`] is the closest copy of the `IndexVec` struct from `librustc_index`, //! but API is also different from standard Rust [`std::vec::Vec`] //! and it has no typed index [`slice`] alternative. //! - [`index_vec`] have both [`slice`] and [`std::vec::Vec`] wrapper //! and API closer to standard API. //! But it implicitly allows you to use `usize` for get methods and index expressions //! that reduce type-safety, //! and the macro `define_index_type!` which is used to generate a newtyped index struct, //! implicitly implements a lot of traits that in my opinion would be better implemented //! only when necessary using crates intended for this, such as [`derive_more`]. //! //! # License //! //! Licensed under either of //! //! - Apache License, Version 2.0 //! ([LICENSE-APACHE](https://github.com/zheland/typed-index-collections/blob/master/LICENSE-APACHE) or //! <https://www.apache.org/licenses/LICENSE-2.0>) //! - MIT license //! ([LICENSE-MIT](https://github.com/zheland/typed-index-collections/blob/master/LICENSE-MIT) or //! <https://opensource.org/licenses/MIT>) //! //! at your option. //! //! ## Contribution //! //! Unless you explicitly state otherwise, any contribution intentionally submitted //! for inclusion in the work by you, as defined in the Apache-2.0 license, //! shall be dual licensed as above, without any //! additional terms or conditions. //! //! [`TiSlice`]: struct.TiSlice.html //! [`TiVec`]: struct.TiVec.html //! [`std`]: https://doc.rust-lang.org/std/index.html //! [`alloc`]: https://doc.rust-lang.org/alloc/index.html //! [`slice`]: https://doc.rust-lang.org/std/primitive.slice.html //! [`Box`]: https://doc.rust-lang.org/std/boxed/struct.Box.html //! [`Rc`]: https://doc.rust-lang.org/std/rc/struct.Rc.html //! [`Weak`]: https://doc.rust-lang.org/std/rc/struct.Weak.html //! [`std::vec::Vec`]: https://doc.rust-lang.org/std/vec/struct.Vec.html //! [`std::error::Error`]: https://doc.rust-lang.org/std/error/trait.Error.html //! [`std::panic::UnwindSafe`]: https://doc.rust-lang.org/std/panic/trait.UnwindSafe.html //! [`From`]: https://doc.rust-lang.org/std/convert/trait.From.html //! [`Into`]: https://doc.rust-lang.org/std/convert/trait.Into.html //! [`AsRef`]: https://doc.rust-lang.org/std/convert/trait.AsRef.html //! [`AsMut`]: https://doc.rust-lang.org/std/convert/trait.AsMut.html //! [`derive_more`]: https://crates.io/crates/derive_more //! [`typed_index_collection`]: https://crates.io/crates/typed_index_collection //! [`indexed_vec`]: https://crates.io/crates/indexed_vec //! [`index_vec`]: https://crates.io/crates/index_vec //! [`Serialize`]: https://docs.serde.rs/serde/trait.Serialize.html //! [`Deserialize`]: https://docs.serde.rs/serde/trait.Deserialize.html #![warn( clippy::all, rust_2018_idioms, missing_copy_implementations, missing_debug_implementations, single_use_lifetimes, missing_docs, trivial_casts, unused_import_braces, unused_qualifications, unused_results )] #![no_std] #[cfg(all(feature = "alloc", not(feature = "std")))] extern crate alloc; #[cfg(feature = "std")] extern crate std as alloc; #[cfg(test)] #[macro_use] mod test; mod iter; mod range; mod slice; #[cfg(any(feature = "alloc", feature = "std"))] mod vec; pub use iter::{TiEnumerated, TiSliceKeys, TiSliceMutMap, TiSliceRefMap}; pub use range::TiRangeBounds; pub use slice::{TiSlice, TiSliceIndex}; #[cfg(any(feature = "alloc", feature = "std"))] pub use vec::TiVec;