Struct sweeper::Clearing

pub struct Clearing<'f> { /* fields omitted */ }

A clearing on the specified field.

This is merely a reference to the area on a field which is known to be a clearing. Nothing is owned by this structure.

Methods

impl<'f> Clearing<'f>

pub fn new(field: &'f Field, anchor_location: FieldCoordinates) -> Option<Self>

Returns a Clearing on the specified Field, or None if the location has 1 or more neighboring mines or is out of bounds.

pub fn field(self) -> &'f Field

Returns the field on which this clearing is located.

pub fn anchor_location(self) -> FieldCoordinates

Returns the location around which this clearing is formed.

This can be any location inside the clearing. More specifically, the one used during creation is returned.

pub fn for_every_tile<F>(self, include_shore: bool, f: F) where
    F: FnMut(&'f Field, FieldCoordinates), 

Executes the specified closure on every tile inside the clearing. Optionally can include the "shore" (tiles with numbers) as a part of the clearing.

The closure takes a reference to the field as the first argument and the location of the tile as the second one. No return value is expected.

#[must_use = "fully traversing a clearing is an expensive operation involving memory allocation"]pub fn size(self, include_shore: bool) -> NonZeroUsize

Returns the size of the clearing, in tiles. Optionally can include the "shore" (tiles with numbers) as a part of the clearing.

#[must_use = "fully traversing a clearing is an expensive operation involving memory allocation"]pub fn includes(
    self,
    coordinates: FieldCoordinates,
    include_shore: bool
) -> bool

Returns true if the given tile is inside the clearing, false otherwise. Optionally can include the "shore" (tiles with numbers) as a part of the clearing.

Trait Implementations

impl<'f> Clone for Clearing<'f>

fn clone(&self) -> Clearing<'f>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'f> Copy for Clearing<'f>

impl<'f> From<ClearingMut<'f>> for Clearing<'f>

fn from(op: ClearingMut<'f>) -> Self

Performs the conversion.