cc-traits 2.0.0

Common collection traits
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

use cc_traits::{Back, Collection, PushBack};
#[cfg(feature = "std")]
use std::collections::VecDeque;

/// Ordered stack.
#[derive(Default)]
pub struct Ordered<S> {
	inner: S,
}

impl<S> Ordered<S> {
	pub fn new() -> Self
	where
		S: Default,
	{
		Default::default()
	}
}

impl<S> Ordered<S> {
	/// Push the given element on the stack iff it is grater or equal
	/// to every other element already in the stack.
	pub fn try_push<T>(&mut self, element: T) -> Result<(), T>
	where
		T: PartialOrd,
		S: Collection<Item = T> + Back + PushBack, // `S` must be a stack providing `back` and `push_back`.
		for<'a> S::ItemRef<'a>: PartialOrd<&'a T>, // The reference type must be comparable with other reference types.
	{
		if self
			.inner
			.back()
			.map(|back| back <= &element)
			.unwrap_or(true)
		{
			self.inner.push_back(element);
			Ok(())
		} else {
			Err(element)
		}
	}
}

fn main() {
	#[cfg(feature = "std")]
	fn ordered_stack_usage<S>()
	where
		S: Default + Collection<Item = i32> + Back + PushBack,
		for<'a> S::ItemRef<'a>: PartialOrd<&'a i32>,
	{
		let mut ordered: Ordered<S> = Ordered::new();
		assert!(ordered.try_push(1).is_ok());
		assert!(ordered.try_push(2).is_ok());
		assert!(ordered.try_push(0).is_err());
	}

	#[cfg(feature = "std")]
	ordered_stack_usage::<Vec<i32>>(); // a `Vec` is a stack so it works.

	#[cfg(feature = "std")]
	ordered_stack_usage::<VecDeque<i32>>(); // a `VecDeque` is also a stack.
}