Struct Suit4

pub struct Suit4(/* private fields */);

Suit Masks

Memory Layout:

[8, 0]:   xxxxCDHS // x: unused

Implementations

impl Suit4

pub const fn from_u8(v: u8) -> Self

Constructs Suit4 from u8

Examples

use open_pql::{Suit, Suit4};

let i: u8 = 0b0011;
let suits: Suit4 = Suit4::from_u8(i);

assert_eq!(suits, Suit4::from([Suit::S, Suit::H].as_ref()));

pub const fn to_u8(self) -> u8

Returns the inner u8

Examples

use open_pql::Suit4;

let i: u8 = 0b0011;
let suits: Suit4 = Suit4::from_u8(i);

assert_eq!(i, suits.to_u8());

pub const fn empty() -> Self

Constructs an empty Suit4

Examples

use open_pql::Suit4;

let suits: Suit4 = Suit4::empty();

assert_eq!(suits, Suit4::from([].as_ref()));

pub const fn is_empty(self) -> bool

Checks whether all suit masks are unset

Examples

use open_pql::{Suit, Suit4};

let empty: Suit4 = Suit4::empty();
let not_empty: Suit4 = Suit4::from(Suit::D);

assert!(empty.is_empty());
assert!(!not_empty.is_empty());

pub const fn set(&mut self, s: Suit)

Mark a Suit

Examples

use open_pql::{Suit, Suit4};

let mut suits: Suit4 = Suit4::empty();
suits.set(Suit::D);

assert_eq!(suits, Suit4::from(Suit::D));

pub const fn unset(&mut self, s: Suit)

Unmark a Suit

Examples

use open_pql::{Suit, Suit4};

let mut suits: Suit4 = Suit4::from(Suit::D);
suits.unset(Suit::D);

assert_eq!(suits, Suit4::empty());

pub const fn contains_suit(self, s: Suit) -> bool

Checks whether a Suit is marked

Examples

use open_pql::{Suit, Suit4};

let mut suits: Suit4 = Suit4::from(Suit::D);

assert!(suits.contains_suit(Suit::D));
assert!(!suits.contains_suit(Suit::H));

pub const fn count(&self) -> PQLCardCount

Returns the number of marked suits

Examples

use open_pql::{Suit, Suit4};

let mut suits: Suit4 = Suit4::from(Suit::D);

assert_eq!(suits.count(), 1);

pub const fn is_empty_alt(self) -> bool

Checks if the collection is empty

Trait Implementations

impl BitAnd for Suit4

type Output = Suit4

The resulting type after applying the & operator.

fn bitand(self, rhs: Suit4) -> Suit4

Performs the & operation.

impl BitOr for Suit4

type Output = Suit4

The resulting type after applying the | operator.

fn bitor(self, rhs: Suit4) -> Suit4

Performs the | operation.

impl Clone for Suit4

fn clone(&self) -> Suit4

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Suit4

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Suit4

fn default() -> Suit4

Returns the “default value” for a type.

impl From<&[Suit]> for Suit4

fn from(ss: &[Suit]) -> Self

Converts to this type from the input type.

impl From<Card64> for Suit4

fn from(c: Card64) -> Self

Converts to this type from the input type.

impl From<Suit> for Suit4

fn from(s: Suit) -> Self

Converts to this type from the input type.

impl PartialEq for Suit4

fn eq(&self, other: &Suit4) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Suit4

impl Eq for Suit4

impl StructuralPartialEq for Suit4