Struct Suit4

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

Suit Masks

A compact bit-set representation for storing multiple suits using a single u8. Each bit represents whether a specific suit is present in the set. Supports efficient set operations like union, intersection, and membership testing.

Memory Layout:

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

Examples

use open_pql::{Suit::*, Suit4};

let mut suits = Suit4::default();
suits.set(S);
suits.set(H);

assert!(suits.contains_suit(S));
assert_eq!(suits.count(), 2);

Implementations

impl Suit4

pub const fn is_empty(self) -> bool

Checks whether all suit masks are unset

Examples

use open_pql::{Suit, Suit4};

let empty: Suit4 = Suit4::default();
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::default();
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::default());

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);

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