Struct SquareBoardBuilder 

pub struct SquareBoardBuilder { /* private fields */ }

A builder for boards with square-shaped cells, i.e. the rectangular boards found in Numberlink puzzles and in Flow Free and the Bridges and Warps expansions.

Implementations

impl SquareBoardBuilder

pub fn add_warp( &mut self, location: Location, direction: Option<SquareStep>, ) -> &mut Self

Add a warp at the specified location pointing in direction. A warp is located on one edge of the board and connects one cell to its partner on the opposite edge of the board along a cardinal direction.

Specifying direction necessary if and only if location is at a corner, in which case the direction is ambiguous. If location is on an edge but not at a corner, direction is ignored regardless of whether it is specified.

May cause the builder to enter a FeatureOutOfBounds invalid state if location is out of bounds or not on an edge. May cause the builder to enter a WarpBadDirection invalid state if location is at a corner and direction is missing or is impossible for a warp at this location. If the builder is already in an invalid state, this function does nothing.

Trait Implementations

impl Builder<SquareStep> for SquareBoardBuilder

fn with_dims(dims: (NonZero<usize>, NonZero<usize>)) -> Self

Construct a new Self with the specified dimensions, specified in (x, y) order.

fn add_termini( &mut self, display: char, locations: (Location, Location), ) -> &mut Self

Add termini or “flow endpoints”. The order in which locations are specified does not matter.

fn pop_termini(&mut self) -> &mut Self

Remove the most recently added pair of termini.

fn add_bridge(&mut self, location: Location) -> &mut Self

Add a bridge at the specified location.

fn drop_location(&mut self, location: Location) -> &mut Self

Drop a location from the board. Any feature here, such as a bridge, warp, or terminus, will be deleted regardless of where in the chain this method is called. Keep in mind this may cause the board to become unsolvable.

fn disconnect(&mut self, locations: UnorderedPair<Location>) -> &mut Self

Disconnect the two locations, i.e. place a wall between them.

fn disconnect_around( &mut self, location: Location, directions: &Vec<SquareStep>, ) -> &mut Self

Shorthand for multiple calls to Self::disconnect, with the same conditions.

fn is_valid(&self) -> Option<&[BuilderInvalidReason]>

Check the validity of this builder, ensuring no BuilderInvalidReason condition has arisen.

fn build(&self) -> Result<Board<SquareStep>, &[BuilderInvalidReason]>

Convert the state of this builder into a Board. If the builder is invalid for any reason, a reference to a Vec of BuilderInvalidReason will indicate why.

impl Clone for SquareBoardBuilder

fn clone(&self) -> SquareBoardBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SquareBoardBuilder

fn default() -> Self

Returns the “default value” for a type.