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
//! This crate provides interop between the [arrayvec] and [generic_array] crates, allowing you to //! use generic_array's [`GenericArray`] as the backing storage for the data structures in //! arrayvec. This lets you have vector and string types that store their contents inline, with a //! capacity that can be referred to in generic code. //! //! # Usage //! //! This crate exposes the type aliases [`GenericArrayVec`]s and [`GenericArrayString`], which are //! aliases of datatypes in the `arrayvec` crate. See the [`ArrayVec`] and [`ArrayString`] docs //! to learn about their functionality. Each one also has a corresponding extension trait //! [`GenericArrayVecExt`] and [`GenericArrayStringExt`] that provide additional constructors and //! conversions. //! //! An example of instantiating and pushing an item onto a `GenericArrayVec`: //! //! ```rust //! use generic_arrayvec::{GenericArrayVec, typenum::U5}; //! //! // Create a new GenericArrayVec of inferred element type with a capacity of 5 //! let mut arr = GenericArrayVec::<_, U5>::new(); //! //! arr.push(10); //! ``` //! //! [arrayvec]: arrayvec //! [generic_array]: generic_array //! [`GenericArrayVec`]: type.GenericArrayVec.html //! [`GenericArrayString`]: type.GenericArrayString.html //! [`GenericArray`]: https://docs.rs/generic-array/0.14/generic_array/struct.GenericArray.html //! [`ArrayVec`]: https://docs.rs/arrayvec/0.5/arrayvec/struct.ArrayVec.html //! [`ArrayString`]: https://docs.rs/arrayvec/0.5/arrayvec/struct.ArrayString.html //! [`GenericArrayVecExt`]: trait.GenericArrayVecExt.html //! [`GenericArrayStringExt`]: trait.GenericArrayStringExt.html #![no_std] #![doc(html_root_url = "https://docs.rs/generic-arrayvec/0.3.0")] #![warn( rust_2018_idioms, deprecated_in_future, macro_use_extern_crate, missing_debug_implementations, unused_qualifications )] pub use arrayvec; pub use generic_array::{self, typenum}; use arrayvec::{Array, ArrayString, ArrayVec, CapacityError}; use core::str::Utf8Error; use generic_array::{ArrayLength, GenericArray}; /// A [`GenericArray`]-backed [`ArrayVec`]. /// /// [`GenericArray`]: https://docs.rs/generic-array/0.14/generic_array/struct.GenericArray.html /// [`ArrayVec`]: https://docs.rs/arrayvec/0.5/arrayvec/struct.ArrayVec.html pub type GenericArrayVec<T, N> = ArrayVec<Wrapper<T, N>>; /// A [`GenericArray`]-backed [`ArrayString`]. /// /// [`GenericArray`]: https://docs.rs/generic-array/0.14/generic_array/struct.GenericArray.html /// [`ArrayString`]: https://docs.rs/arrayvec/0.5/arrayvec/struct.ArrayString.html pub type GenericArrayString<N> = ArrayString<Wrapper<u8, N>>; /// A wrapper around a [`GenericArray`] that implements the [`Array`] trait from the arrayvec /// crate, allowing it to be used as the backing store for [`ArrayVec`] and [`ArrayString`]. /// /// You probably don't need to use this type directly; just use the constructors provided by the /// [`GenericArrayVecExt`] and [`GenericArrayStringExt`] traits. /// /// [`GenericArray`]: https://docs.rs/generic-array/0.14/generic_array/struct.GenericArray.html /// [`Array`]: https://docs.rs/arrayvec/0.5/arrayvec/trait.Array.html /// [`ArrayVec`]: https://docs.rs/arrayvec/0.5/arrayvec/struct.ArrayVec.html /// [`ArrayString`]: https://docs.rs/arrayvec/0.5/arrayvec/struct.ArrayString.html /// [`GenericArrayVecExt`]: trait.GenericArrayVecExt.html /// [`GenericArrayStringExt`]: trait.GenericArrayStringExt.html #[derive(Debug, Clone)] pub struct Wrapper<T, N>(pub GenericArray<T, N>) where N: ArrayLength<T>; impl<T, N> Wrapper<T, N> where N: ArrayLength<T>, { /// Returns the inner `GenericArray` inside this `Wrapper` pub fn into_inner(self) -> GenericArray<T, N> { self.0 } } impl<T, N> Copy for Wrapper<T, N> where T: Copy, N: ArrayLength<T>, N::ArrayType: Copy, { } impl<T, N> From<GenericArray<T, N>> for Wrapper<T, N> where N: ArrayLength<T>, { fn from(arr: GenericArray<T, N>) -> Self { Wrapper(arr) } } impl<T, N> Into<GenericArray<T, N>> for Wrapper<T, N> where N: ArrayLength<T>, { fn into(self) -> GenericArray<T, N> { self.0 } } unsafe impl<T, N> Array for Wrapper<T, N> where N: ArrayLength<T>, { type Item = T; type Index = usize; const CAPACITY: usize = N::USIZE; fn as_slice(&self) -> &[Self::Item] { self.0.as_slice() } fn as_mut_slice(&mut self) -> &mut [Self::Item] { self.0.as_mut_slice() } } /// Extension trait for [`GenericArrayVec`]. /// /// See its impl on [`GenericArrayVec`] for more info. /// /// [`GenericArrayVec`]: type.GenericArrayVec.html pub trait GenericArrayVecExt<T, N> where N: ArrayLength<T>, { fn generic_from<A>(arr: A) -> GenericArrayVec<T, N> where A: Into<GenericArray<T, N>>; fn into_generic_array(self) -> Result<GenericArray<T, N>, Self> where Self: Sized; } impl<T, N> GenericArrayVecExt<T, N> for GenericArrayVec<T, N> where N: ArrayLength<T>, { /// Creates a `GenericArrayVec` from an array or `GenericArray`. /// /// ```rust /// use generic_arrayvec::{GenericArrayVec, GenericArrayVecExt}; /// /// let vec = GenericArrayVec::generic_from([2, 4, 6, 8]); /// /// assert_eq!(vec.len(), 4); /// assert_eq!(vec.capacity(), 4); /// ``` fn generic_from<A>(arr: A) -> GenericArrayVec<T, N> where A: Into<GenericArray<T, N>>, { ArrayVec::from(Wrapper::from(arr.into())) } /// Returns the inner `GenericArray`, if `self` is full to its capacity. /// /// **Errors** if `self` is not filled to capacity. /// /// ```rust /// use generic_arrayvec::{GenericArrayVec, GenericArrayVecExt, typenum::U5}; /// /// let mut vec = GenericArrayVec::<i32, U5>::new(); /// vec.push(0); /// vec.extend(1..5); /// /// let generic_array = vec.into_generic_array().unwrap(); /// /// assert_eq!(&*generic_array, &[0, 1, 2, 3, 4][..]); /// ``` fn into_generic_array(self) -> Result<GenericArray<T, N>, Self> { Ok(self.into_inner()?.into_inner()) } } /// Extension trait for [`GenericArrayString`]. /// /// See its impl on [`GenericArrayString`] for more info. /// /// [`GenericArrayString`]: type.GenericArrayString.html pub trait GenericArrayStringExt<N> where N: ArrayLength<u8>, N::ArrayType: Copy, { fn generic_from(string: &str) -> Result<GenericArrayString<N>, CapacityError<&str>>; fn generic_from_byte_string<A>(byte_string: &A) -> Result<GenericArrayString<N>, Utf8Error> where A: Into<GenericArray<u8, N>> + AsRef<[u8]>; } impl<N> GenericArrayStringExt<N> for GenericArrayString<N> where N: ArrayLength<u8>, N::ArrayType: Copy, { /// Creates a `GenericArrayString` from a `str`. /// /// Capacity is inferred from the type parameter. /// /// **Errors** if the capacity is not large enough to fit the string. /// /// ```rust /// use generic_arrayvec::{GenericArrayString, GenericArrayStringExt, typenum::U10}; /// /// let string = GenericArrayString::<U10>::generic_from("hello").unwrap(); /// /// assert_eq!(string.len(), 5); /// assert_eq!(string.capacity(), 10); /// ``` fn generic_from(string: &str) -> Result<GenericArrayString<N>, CapacityError<&str>> { ArrayString::from(string) } /// Creates a `GenericArrayString` from a byte string. /// /// The `GenericArrayString`'s length and capacity will be equal to the input byte string. /// /// **Errors** if the byte string is not valid UTF-8. /// /// # Examples /// /// From a byte string literal: /// /// ```rust /// use generic_arrayvec::{GenericArrayString, GenericArrayStringExt}; /// /// let string = GenericArrayString::generic_from_byte_string(b"hello").unwrap(); /// /// assert_eq!(string.len(), 5); /// assert_eq!(string.capacity(), 5); /// ``` /// /// From a byte-holding `GenericArray`: /// /// ```rust /// use generic_arrayvec::{ /// GenericArrayString, GenericArrayStringExt, /// generic_array::GenericArray, /// }; /// /// let arr = GenericArray::from([b'h', b'i']); /// let string = GenericArrayString::generic_from_byte_string(&arr).unwrap(); /// /// assert_eq!(string.len(), 2); /// assert_eq!(string.capacity(), 2); /// ``` fn generic_from_byte_string<A>(byte_string: &A) -> Result<GenericArrayString<N>, Utf8Error> where A: Into<GenericArray<u8, N>> + AsRef<[u8]>, { ArrayString::from_byte_string(&Wrapper::from(GenericArray::clone_from_slice( byte_string.as_ref(), ))) } }