contains 0.1.0

A Container trait
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
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

//! # Contains
//! The Contains crate has 2 traits Container and In. 
//! 
//! ## Container
//! The Container trait can be used to abstract over
//! types that can contain items: `Vec<T>`, `&[T]`, `HashMap<T>`, `Option<T>`, ect.
//! ```rust
//! use contains::Container;
//! 
//! let vec = vec![1, 2, 3, 4, 5];
//! let range = 0..5;
//! let option = Some(3);
//! 
//! let containers: &[&dyn Container<usize>] = &[&vec, &range, &option];
//! for container in containers {
//!   assert!(container.does_contain(&3));
//! }
//! ```
//! 
//! ## In
//! The In trait is the Inverse of the Container trait and represents a type that is in
//! a container. Mainly it reverse the call order by providing the `is_in` method.
//! ```rust
//! use contains::{Container, In};
//! 
//! let range = 0..5;
//! assert!(range.does_contain(&3));    // using does_contain
//! assert!(3.is_in(&range));           // using in
//! ```

/// ## Container
/// The Container trait can be used to abstract over
/// types that can contain items: `Vec<T>`, `&[T]`, `HashMap<T>`, `Option<T>`, ect.
/// ```rust
/// use contains::Container;
/// 
/// let vec = vec![1, 2, 3, 4, 5];
/// let range = 0..5;
/// let option = Some(3);
/// 
/// let containers: &[&dyn Container<usize>] = &[&vec, &range, &option];
/// for container in containers {
///   assert!(container.does_contain(&3));
/// }
/// ```
/// 
/// A `&str` is considered a container of `&str` and `&[T]` is considered a container of `&[T]`.
/// ```rust
/// use contains::Container;
/// 
/// assert!("hello world!".does_contain(&"hello"));
/// 
/// assert!([1,2,3,4,5].does_contain(&[3, 4]));
/// ```
pub trait Container<T> {
    fn does_contain(&self, item: &T) -> bool;
}

/// ## In
/// The In trait is the Inverse of the Container trait and represents a type that is in
/// a container. Mainly it reverse the call order by providing the `is_in` method.
/// ```rust
/// use contains::{Container, In};
/// 
/// let range = 0..5;
/// assert!(range.does_contain(&3));    // using does_contain
/// assert!(3.is_in(&range));           // using in
/// ```
pub trait In<C> {
    fn is_in(&self, container: &C) -> bool;
}
 
impl<C, T> In<C> for T where C : Container<T> {
    fn is_in(&self, container: &C) -> bool { container.does_contain(self) }
}

impl<T> Container<T> for Vec<T> where T: PartialEq<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for Option<T> where T: PartialEq<T> {
    fn does_contain(&self, item: &T) -> bool {
        match self {
            Some(x) if x == item => true,
            _ => false
        }
    }
}

impl<T, U> Container<T> for Result<T, U> where T: PartialEq<T> {
    fn does_contain(&self, item: &T) -> bool {
        match self {
            Ok(x) if x == item => true,
            _ => false
        }
    }
}

impl<T> Container<T> for std::collections::HashSet<T> where T: Eq + std::hash::Hash  {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::collections::BTreeSet<T> where T: Ord {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::collections::LinkedList<T> where T: PartialEq<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::collections::VecDeque<T> where T: PartialEq<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl Container<&str> for &str {
    fn does_contain(&self, item: &&str) -> bool {
        self.contains(item)
    }
}

impl Container<&str> for String {
    fn does_contain(&self, item: &&str) -> bool {
        self.contains(item)
    }
}


impl<T, const N: usize> Container<T> for [T; N] where T: PartialEq<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for &[T] where T: PartialEq<T>  {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<&[T]> for &[T] where T: PartialEq<T> {
    fn does_contain(&self, item: &&[T]) -> bool {
        for slice in self.windows(item.len()) {
            if &slice == item {
                return true;
            }
        }
        return false;
    }
}

impl<T, const N1: usize, const N: usize> Container<[T; N1]> for [T; N] where T: PartialEq<T> {
    fn does_contain(&self, item: &[T; N1]) -> bool {
        let container : &[T] = self;
        let item : &[T] = item;
        container.does_contain(&item)
    }
}

impl<T, const N1: usize> Container<[T; N1]> for &[T] where T: PartialEq<T> {
    fn does_contain(&self, item: &[T; N1]) -> bool {
        let container : &[T] = self;
        let item : &[T] = item;
        container.does_contain(&item)
    }
}

impl<T, const N: usize> Container<&[T]> for [T; N] where T: PartialEq<T> {
    fn does_contain(&self, item: &&[T]) -> bool {
        let container : &[T] = self;
        let item : &[T] = item;
        container.does_contain(&item)
    }
}

impl<T, const N1: usize> Container<[T; N1]> for Vec<T> where T: PartialEq<T> {
    fn does_contain(&self, item: &[T; N1]) -> bool {
        let container : &[T] = self;
        let item : &[T] = item;
        container.does_contain(&item)
    }
}

impl<T> Container<&[T]> for Vec<T> where T: PartialEq<T> {
    fn does_contain(&self, item: &&[T]) -> bool {
        let container : &[T] = self;
        let item : &[T] = item;
        container.does_contain(&item)
    }
}

impl<T> Container<T> for std::ops::Range<T> where T: PartialOrd<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::ops::RangeFrom<T> where T: PartialOrd<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::ops::RangeTo<T> where T: PartialOrd<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::ops::RangeFull where T: PartialOrd<T> {
    fn does_contain(&self, item: &T) -> bool {
        std::ops::RangeBounds::contains(self, item)
    }
}

impl<T> Container<T> for std::ops::RangeInclusive<T> where T: PartialOrd<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}

impl<T> Container<T> for std::ops::RangeToInclusive<T> where T: PartialOrd<T> {
    fn does_contain(&self, item: &T) -> bool {
        self.contains(item)
    }
}


#[test]
fn test_container() {
    let array = [1, 2, 3, 4, 5];
    let slice = &[1, 2, 3, 4, 5] as &[i32];
    let vec = vec![1, 2, 3, 4, 5];
    let opt = Some(3);
    let res : Result<i32, i32> = Ok(3);
    let bts = {
        let mut init = std::collections::BTreeSet::new();
        init.insert(3);
        init
    };
    let hs = {
        let mut init = std::collections::HashSet::new();
        init.insert(3);
        init
    };
    let rng = 0..6;

    let collections : &[&dyn Container<i32>] = &[&array, &slice, &vec, &opt, &res, &bts, &hs, &rng];
    for container in collections {
        assert!(container.does_contain(&3));
    }

    let str = "Hello World";
    let string = String::from("Hello World");
    let haystacks : &[&dyn Container<&str>] = &[&str, &string];
    for container in haystacks {
        assert!(container.does_contain(&"Hello"));
    }

}