Struct spacebattleship::board::setup::ShipEntryMut

pub struct ShipEntryMut<'a, I, D: Dimensions, S> { /* fields omitted */ }

Reference to a particular ship's placement info as well as the grid, providing access to the methods necessary to check it's placement status and place or unplace it.

Implementations

impl<'a, I: ShipId, D: Dimensions, S: ShipShape<D>> ShipEntryMut<'a, I, D, S>

pub fn id(&self) -> &I

Get the ID of this ship.

pub fn placed(&self) -> bool

Returns true if this ship has been placed.

pub fn get_placements(
    &self,
    coord: D::Coordinate
) -> ProjectIter<D, S::ProjectIterState>

Get an interator over possible projections of the shape for this ship that start from the given [Coordinate]. If there are no possible placements from the given coordinate, including if the coordinate is out of bounds, the resulting iterator will be empty.

pub fn check_placement(
    &self,
    placement: &ShapeProjection<D::Coordinate>
) -> Result<(), CannotPlaceReason>

Check if the specified placement is valid for this ship.

impl<'a, I: ShipId, D: Dimensions, S: ShipShape<D>> ShipEntryMut<'a, I, D, S>

pub fn placement(&self) -> Option<&ShapeProjection<D::Coordinate>>

If the ship is placed, get the placement. Otherwise return None.

pub fn place(
    &mut self,
    placement: ShapeProjection<D::Coordinate>
) -> Result<(), PlaceError<ShapeProjection<D::Coordinate>>>

Attempts to place the ship with onto the given coordinates. If the ship is already placed, returns Err with the attempted placement and reason placement failed, otherwise returns Ok(())

pub fn unplace(&mut self) -> Option<ShapeProjection<D::Coordinate>>

Attempt to clear the placement of the ship. Returns the previous placement of the ship if any. Returns None if the ship has not been placed.