oreodave/big-c
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modes:pair: add doc string for Pair::new

Browse Source
This commit is contained in:
Aryadev Chavali
2026-04-02 06:06:16 +01:00
committed by oreodave
parent fea8f1716d
commit 439b787040
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/modes/pair.rs
View File

@@ -5,6 +5,12 @@ use crate::helper::ordered;
pub struct Pair(Card, Card); pub struct Pair(Card, Card);
impl Pair { impl Pair {
/** Create a new pair utilising two cards, `c1` and `c2`. Will return None
if a Pair cannot be constructed out of the two cards.
NOTE: By construction, if the Pair includes a Joker, that Joker will be the
first member of the pair.
*/
fn new(c1: Card, c2: Card) -> Option<Pair> { fn new(c1: Card, c2: Card) -> Option<Pair> {
// Order the cards. This means if xor(c1 is joker, c2 is joker) c1 will // Order the cards. This means if xor(c1 is joker, c2 is joker) c1 will
// be that joker. // be that joker.