maze_generator 2.0.0

A library of different maze generation algorithms.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Common traits and members

use anyhow::Result;
use thiserror::Error;

pub use coordinates::*;
pub use direction::*;
pub use field::*;
pub use maze::*;
pub use svgoptions::*;

mod coordinates;
mod direction;
mod field;
mod maze;
mod svgoptions;

/// Generic error type that could be returned by all implemented generators.
#[derive(Error, Debug, Clone, Eq, PartialEq)]
pub enum GenericGeneratorError {
    /// Error that can be raised anywhere in a generator that is not otherwise explicitly handled.
    ///
    /// This is used as a way to signal bugs.
    /// They should hopefully never actually be raised but if they are, a bug should be reported.
    #[error("Unknown internal error. If this is reproducible, please report a bug at https://github.com/ftsell/maze_generator/issues/new : {0}")]
    InternalError(String),
}

/// Generic generator Api implemented by all algorithms to generate a maze
pub trait Generator {
    /// Key function to generate a maze
    ///
    /// The returned [`Maze`] will have the provided width and height.
    /// It can be any rectangular shape.
    fn generate(&mut self, width: i32, height: i32) -> Result<Maze>;
}