Skip to main content

Keep

yahtzee_engine

Struct Keep 

Source 
pub struct Keep { /* private fields */ }
Expand description

A sub-multiset of zero to five dice held between rolls.

A separate type from Dice keeps “a full roll” and “what I am keeping” from being confused: every function that needs five dice takes Dice, and the type system rules out partial rolls there.

Implementations§

Source§

impl Keep

Source

pub const EMPTY: Self

Keeping no dice: reroll everything.

Source

pub const fn from_counts(counts: [u8; 6]) -> Option<Self>

Builds a keep from face counts (counts[f - 1] dice show f).

Returns None if the counts sum to more than five.

Source

pub const fn count(self, face: u8) -> u8

How many dice show face (1..=6).

§Panics

Panics if face is outside 1..=6.

Source

pub const fn counts(self) -> [u8; 6]

The face counts, indexed by face - 1.

Source

pub const fn len(self) -> u8

The number of dice kept.

Source

pub const fn is_empty(self) -> bool

Whether no dice are kept.

Trait Implementations§

Source§

impl Clone for Keep

Source§

fn clone(&self) -> Keep

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Keep

Source§

impl Debug for Keep

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Keep

Source§

fn default() -> Keep

Returns the “default value” for a type. Read more
Source§

impl Display for Keep

Source§

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

The kept faces in ascending order, empty when nothing is kept.

Source§

impl Eq for Keep

Source§

impl From<Dice> for Keep

Source§

fn from(dice: Dice) -> Self

Keeping all five dice.

Source§

impl FromStr for Keep

Source§

fn from_str(s: &str) -> Result<Self, ParseDiceError>

Parses up to five digits 1–6, ignoring whitespace. The empty string is Keep::EMPTY.

Source§

type Err = ParseDiceError

The associated error which can be returned from parsing.
Source§

impl Hash for Keep

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Keep

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Keep

Source§

impl TryFrom<&[u8]> for Keep

Source§

fn try_from(faces: &[u8]) -> Result<Self, ParseDiceError>

Builds a keep from at most five faces in any order.

Source§

type Error = ParseDiceError

The type returned in the event of a conversion error.

Auto Trait Implementations§

§

impl Freeze for Keep

§

impl RefUnwindSafe for Keep

§

impl Send for Keep

§

impl Sync for Keep

§

impl Unpin for Keep

§

impl UnsafeUnpin for Keep

§

impl UnwindSafe for Keep

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.