Struct world_map_gen::board::Board

pub struct Board<'a> { /* fields omitted */ }

A struct to represent a one world map. It is generally created by gen module's random map generator. This struct is JSON serializable with serde_json.

Methods

impl<'a> Board<'a>

pub fn build<F>(width: usize, height: usize, builder: F) -> Board<'a> where
    F: FnMut(usize, usize) -> Land<'a>, 

Builds a board with given width * height cells. The builder generates a cell at the given position (x, y) by returning land::Land instance. Note that you can use land::LandKind::preset() to utilize a preset land instance easily.

pub fn width(&self) -> usize

Returns number of cells per row

pub fn height(&self) -> usize

Returns number of rows

pub fn at(&self, x: usize, y: usize) -> &Land

Returns a reference to cell at given (x, y) position

pub fn at_mut(&mut self, x: usize, y: usize) -> &'a mut Land

Returns a mutable reference to cell at given (x, y) position

pub fn iter<'b>(&'b self) -> Iter<'b, Land<'a>>

Returns an iterator which iterates all cells from left-top corner to right-bottom corner

pub fn iter_mut<'b>(&'b mut self) -> IterMut<'b, Land<'a>>

Returns a mutable reference iterator which iterates all cells from left-top corner to right bottom corner

pub fn rows<'b>(&'b self) -> Chunks<'b, Land<'a>>

Returns an iterator which iterates each row as slice from top to bottom

pub fn rows_mut<'b>(&'b mut self) -> ChunksMut<'b, Land<'a>>

Returns a mutable reference iterator which iterates each row as slice from top to bottom

Trait Implementations

impl<'a> PartialEq<Board<'a>> for Board<'a>

fn eq(&self, other: &Board<'a>) -> bool

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

fn ne(&self, other: &Board<'a>) -> bool

This method tests for !=.

impl<'a> Debug for Board<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a> Index<Pos> for Board<'a>

type Output = Land<'a>

The returned type after indexing.

fn index(&self, p: Pos) -> &Land<'a>

Returns a reference to cell at given position

impl<'a> IndexMut<Pos> for Board<'a>

fn index_mut(&mut self, p: Pos) -> &mut Land<'a>

Returns a mutable reference to cell at given position

impl<'a> Serialize for Board<'a>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize board in a map which contain width, height, cells as array, and legends for each land kind as map. By serde_json, the struct can be serialized to JSON object.