nonempty-containers 0.2.3

Fast, zero-cost conversion, and fully inter-operable nonempty container types.
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

//! Macros for creating non-empty containers.

/// Creates a [NonEmptyVec] containing the arguments.
///
/// This macro is very similar in goal to the standard library's `vec!` macro:
///
/// - Create a [NonEmptyVec] containing a given list of elements:
///
/// ```
/// # use nonempty_containers::nev;
/// #
/// let ne = nev![1, 2, 3];
/// assert_eq!(ne[0], 1);
/// assert_eq!(ne[1], 2);
/// assert_eq!(ne[2], 3);
/// ```
///
/// - Create a [NonEmptyVec] from a given head element and tail vector.
///
/// ```
/// # use nonempty_containers::{nev, NEVec};
/// #
/// let vec = vec![2, 3, 4];
/// let ne = nev![1; vec];
/// assert_eq!(ne, NEVec::from_vec(vec![1, 2, 3, 4]).unwrap());
/// ```
///
/// Note that unlike [Vec]s, it is not possible to create an empty [NonEmptyVec] using this macro!
#[macro_export]
macro_rules! nev {
    ($elem:expr; $n:expr) => (
        $crate::NEVec::new($elem, $n)
    );
    ($single:expr) => (
        $crate::NEVec::singleton($single)
    );
    ($head:expr, $($tail:expr),+ $(,)?) => (
        $crate::NEVec::new($head, vec![$($tail),+])
    );
}

#[macro_export]
macro_rules! nes {
    ($elem:expr; $n:expr) => (
        $crate::NESet::new($elem, $n)
    );
    ($single:expr) => (
        $crate::NESet::singleton($single)
    );
    ($head:expr, $($tail:expr),+ $(,)?) => (
        $crate::NESet::new($head, vec![$($tail),+])
    );
}

#[macro_export]
macro_rules! neos {
    ($elem:expr; $n:expr) => (
        $crate::NEOrderedSet::new($elem, $n)
    );
    ($single:expr) => (
        $crate::NEOrderedSet::singleton($single)
    );
    ($head:expr, $($tail:expr),+ $(,)?) => (
        $crate::NEOrderedSet::new($head, vec![$($tail),+])
    );
}