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

modes:mod: docs for Hand trait

Browse Source
This commit is contained in:
Aryadev Chavali
2026-04-16 21:10:47 +01:00
parent 9e5bb81f13
commit 0d9480d113
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/modes/mod.rs
View File

@@ -12,16 +12,18 @@ pub enum Footstool {
} }
pub trait Hand: Ord { pub trait Hand: Ord {
// Only need to implement is_proper. /// Return true if the current hand doesn't have any jokers.
fn is_proper(&self) -> bool; fn is_proper(&self) -> bool;
/// Return true if the current hand has at least one Joker.
fn is_improper(&self) -> bool { fn is_improper(&self) -> bool {
!self.is_proper() !self.is_proper()
} }
/// Get the high card of the current hand.
fn high_card(&self) -> Card; fn high_card(&self) -> Card;
/// Given two instances of a Hand (`self` and `other`), verify if `self` /// Given two instances of a Hand (`self` and `other`), return if `self`
/// footstools `other`. /// footstools `other`.
fn footstool(&self, other: &Self) -> Footstool; fn footstool(&self, other: &Self) -> Footstool;
} }