Struct xwords::crossword::Crossword

pub struct Crossword { /* fields omitted */ }

The underlying representation of a crossword puzzle. All of the contents are stored in a string and the dimensions of the grid are stored explicitly.

In the contents, * represents a shaded square, and a represents a blank square.

To parse a square grid, see [xwords::crossword::Crossword::square]. To parse a rectangular grid, see [xwords::crossword::Crossword::rectangle]

Implementations

impl Crossword

pub fn square(contents: String) -> Result<Crossword, String>

Parses a crossword. Assumes that grid width and height are equal and returns an Err if not. Newlines are removed.

pub fn rectangle(
    contents: String,
    width: usize,
    height: usize
) -> Result<Crossword, String>

Parses a crossword. Assumes that width and height are as specified. If the length of the input does not match the input dimensions, an Err is returned. Newlines are removed.

Trait Implementations

impl Clone for Crossword

pub fn clone(&self) -> Crossword

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Crossword

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

Formats the value using the given formatter.

impl Display for Crossword

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

Formats the value using the given formatter.

impl Eq for Crossword

impl Hash for Crossword

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Crossword> for Crossword

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Crossword

impl StructuralPartialEq for Crossword