Struct BoggleBuilder 

pub struct BoggleBuilder { /* private fields */ }

The boggle board builder struct

Implementations

impl BoggleBuilder

pub fn new() -> Self

initiates a new instance of the boggle board builder

pub fn with_dictionary_path<P: Into<String>>(self, path: P) -> Self

sets the trie dictionary text file path

pub fn with_target_score(self, score: isize) -> Self

sets the desired target score for the board to be generated

pub fn with_width(self, width: usize) -> Self

sets the board’s width

pub fn with_length(self, length: usize) -> Self

sets the board’s length

pub fn build(self) -> Result<Option<Board>, Error>

generates a boggle board instance

Examples

use boggle_maker::BoggleBuilder;
let builder = BoggleBuilder::new()
.with_dictionary_path("words.txt")
.with_target_score(2500)
.with_length(4)
.with_width(4);

if let Some(board) = builder.build().expect("Failed to load trie from words.txt file"){
  assert!(board.score().unwrap()>=2500);
}
else{
assert!(false);
}

Trait Implementations

impl Default for BoggleBuilder

fn default() -> BoggleBuilder

Returns the “default value” for a type.