bounded-vector 0.2.2

Vec wrapper that guarantees upper and lower bounds on type level.
Documentation 
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

/// Macro similar to vec!
///
///
/// Examples
///
/// Creating BoundedVec from elements
/// ```rust
/// # use std::error::Error;
/// # use bounded_vector::{BoundedVec, bvec};
/// #
/// # fn main() -> Result<(), Box<dyn Error>> {
/// let bvec: BoundedVec<i32, 0, 3> = bvec![1, 2, 3]?;
/// assert_eq!(vec![1,2,3], bvec.to_vec());
/// # Ok(())
/// # }
/// ```
///
/// Creating BoundedVec from n same elements(must have clone trait)
/// ```rust
/// # use std::error::Error;
/// # use bounded_vector::{BoundedVec, bvec};
/// #
/// # fn main() -> Result<(), Box<dyn Error>> {
/// let bvec: BoundedVec<i32, 0, 3> = bvec![1; 3]?;
/// assert_eq!(vec![1,1,1], bvec.to_vec());
/// # Ok(())
/// # }
/// ```
///
/// Macro gives Error for first two usages if element count don't fit bounds
/// ```rust
/// # use std::error;
/// # use bounded_vector::{BoundedVec, bvec, Error};
/// #
/// # fn main() -> Result<(), Box<dyn error::Error>> {
/// let bvec: Result<BoundedVec<i32, 0, 0>, _> = bvec![1];
/// assert_eq!(bvec, Err(Error::OutOfBoundsVec));
/// # Ok(())
/// # }
/// ```
///
/// Creating empty BoundedVec<_, 0, _>. This usage does not return Result because it ensures correct
/// bounds at the compile time
/// ```rust
/// # use std::error::Error;
/// # use bounded_vector::{BoundedVec, bvec};
/// #
/// # fn main() -> Result<(), Box<dyn Error>> {
/// let bvec: BoundedVec<i32, 0, 0> = bvec![];
/// assert_eq!(BoundedVec::new(), bvec);
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! bvec {
	() => {{
		$crate::BoundedVec::new()
	}};

	($elem:expr; $n:expr) => {
		$crate::BoundedVec::from_elem($elem, $n)
	};

	($($x:expr),+ $(,)?) => {
        $crate::BoundedVec::try_from(<[_]>::into_vec(Box::new([$($x),+])))
	};
}

#[cfg(test)]
mod tests {
	use crate::*;

	#[test]
	fn empty() {
		let vec_from_macro: BoundedVec<i32, 0, 0> = bvec![];
		let vec = BoundedVec::<i32, 0, 0>::new();
		assert_eq!(vec_from_macro, vec);
	}

	#[test]
	fn from_elements() {
		let vec_from_macro: BoundedVec<_, 3, 3> = bvec![1, 2, 3].unwrap();
		assert_eq!(vec_from_macro.to_vec(), vec![1, 2, 3]);

		let vec_from_macro: Result<BoundedVec<_, 0, 0>, _> = bvec![1, 2, 3];
		assert_eq!(vec_from_macro, Err(Error::OutOfBoundsVec));
	}

	#[test]
	fn n_elements() {
		let vec_from_macro: BoundedVec<_, 3, 3> = bvec![2u8; 3].unwrap();
		assert_eq!(vec_from_macro.to_vec(), vec![2, 2, 2]);

		let vec_from_macro: Result<BoundedVec<_, 0, 0>, _> = bvec![2u8; 3];
		assert_eq!(vec_from_macro, Err(Error::OutOfBoundsVec));
	}
}