Enum sweeper::TileState

pub enum TileState<Cf> {
    ClosedEmpty(Flag<Cf>),
    OpenEmpty,
    OpenNumber(NonZeroU8),
    Mine(Flag<Cf>),
}

The state of a tile.

Variants

ClosedEmpty(Flag<Cf>)

A tile which is empty but hasn't been opened yet.

OpenEmpty

A tile which has been opened and doesn't have neighboring mines.

OpenNumber(NonZeroU8)

A tile which has been opened and has neighboring mines.

Mine(Flag<Cf>)

A tile which has a mine inside, and whether it's marked or not.

Methods

impl<Cf> TileState<Cf>

pub fn is_closed(&self) -> bool

Returns true if the tile is closed, false otherwise.

pub fn is_open(&self) -> bool

Returns true if the tile is open, false otherwise.

pub fn is_mine(&self) -> bool

Returns true if the tile contains a mine, false otherwise.

pub fn is_safe(&self) -> bool

Returns true if clicking this tile does not end the game, false otherwise.

pub fn is_required_to_open(&self) -> bool

Returns true if this tile has to be clicked in order for the game to successfully end, false otherwise.

This is false for open mines — returns true only for ClosedEmpty.

pub fn flag_state(&self) -> Option<&Flag<Cf>>

Returns the type of flag installed on this tile, or None if this tile is open and thus cannot hold a flag.

pub fn is_flagged(&self) -> bool

Returns true if the flag_state is Some(Flag::Flagged), false otherwise.

pub fn custom_flag(&self) -> Option<&Cf>

Returns the custom flag value if the tile can hold a flag and the installed flag is a custom one, None otherwise.

pub fn peek_local(&self) -> Option<ClickOutcome>

Returns a ClickOutcome from the data known only to this specific tile, or None if returning one requires access to the field.

Trait Implementations

impl<Cf: Clone> Clone for TileState<Cf>

fn clone(&self) -> TileState<Cf>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Cf: Copy> Copy for TileState<Cf>

impl<Cf: Debug> Debug for TileState<Cf>

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

Formats the value using the given formatter.

impl<Cf> Default for TileState<Cf>

fn default() -> Self

Returns the ClosedEmpty variant.

impl<'de, Cf> Deserialize<'de> for TileState<Cf> where
    Cf: Deserialize<'de>, 

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<Cf> Eq for TileState<Cf>

impl<Ct, Cf> From<TileState<Cf>> for Tile<Ct, Cf> where
    Ct: Default, 

fn from(state: TileState<Cf>) -> Self

Performs the conversion.

impl<Cf> PartialEq<TileState<Cf>> for TileState<Cf>

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

Compares two tiles.

Two tiles are equal if they're both empty or they both contain a mine. Other factors, like the presence of a flag or amount of surrounding mines are not compared.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Cf> Serialize for TileState<Cf> where
    Cf: Serialize, 

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.