fen4/lib.rs
1//! Fen4 provides a mapping from a simple representation of a 4 player chess board and the fen4 file format used by
2//! [Chess.com](https://www.chess.com/4-player-chess).
3//!
4//! ### Quick Start
5//!
6//! The [`Board`] struct is the important type in this crate. All other types are present to support all the features of [`Board`]. The most common ways to get a [`Board`] would be via [`FromStr`](`std::str::FromStr`) or [`Default`](`std::default::Default`).
7//!
8//! ```rust
9//! # fn main() -> Result<(),fen4::BoardParseError> {
10//! let empty_fen = "R-0,0,0,0-0,0,0,0-0,0,0,0-0,0,0,0-0-14/14/14/14/14/14/14/14/14/14/14/14/14/14";
11//! let board : Result<fen4::Board,fen4::BoardParseError> = empty_fen.parse();
12//! println!("{}",board?);
13//! # Ok(())
14//! # }
15//! ```
16
17mod conversions;
18mod display;
19mod from_str;
20mod types;
21
22pub use from_str::BoardParseError;
23pub use from_str::PieceParseError;
24pub use from_str::PositionParseError;
25pub use types::*;