rdeck 0.2.0

a simple library for choosing distinct random elements
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

pub use rand_core::RngCore as Rng;

/// a Deck abstractly represents a source of distinct random elements.
pub trait Deck {
	type Card;
	/// number of remaining cards in the deck.
	fn left(&self) -> usize;
	/// draw a random card from the deck.
	///
	/// panics if there are no more cards in the deck.
	fn draw(&mut self) -> Self::Card;
	/// add all previously drawn cards back into the deck.
	fn refill(&mut self);
	/// draw a random card from the deck, returning None if the deck is empty.
	fn try_draw(&mut self) -> Option<Self::Card> {
		if self.left() > 0 { Some(self.draw()) } else { None }
	}
}

/// convert a container-like type into a [`Deck`] that can be drawn from.
///
/// [`Deck`]: trait.Deck.html
pub trait ToDeck<R: Rng> {
	type Out: Deck;
	/// construct a [`Deck`] using the given rng.
	///
	/// [`Deck`]: trait.Deck.html
	fn to_deck(self, r: R) -> Self::Out;
}