Struct shakmaty::fen::Fen

pub struct Fen(pub Setup);

A FEN like rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1.

Tuple Fields

0: Setup

Implementations

impl Fen

pub const fn empty() -> Fen

The FEN of the empty position 8/8/8/8/8/8/8/8 w - - 0 1.

pub fn from_ascii(fen: &[u8]) -> Result<Fen, ParseFenError>

Parses a FEN or EPD.

FENs consist of parts separated by spaces. This parser also accepts parts separated by underscores. Missing parts are filled with defaults.

Errors

Returns ParseFenError if any part is syntactically invalid.

Example

use shakmaty::fen::Fen;

let fen = Fen::from_ascii(b"rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1")?;
assert_eq!(fen, Fen::default());

pub const fn from_setup(setup: Setup) -> Fen

pub fn from_position<P: Position>(pos: P, mode: EnPassantMode) -> Fen

pub const fn as_setup(&self) -> &Setup

pub const fn into_setup(self) -> Setup

pub fn into_position<P: FromSetup>( self, mode: CastlingMode ) -> Result<P, PositionError<P>>

Set up a Position. See FromSetup.

Errors

Returns PositionError if the setup does not meet basic validity requirements.

Trait Implementations

impl Clone for Fen

fn clone(&self) -> Fen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fen

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

Formats the value using the given formatter.

impl Default for Fen

fn default() -> Fen

Returns the “default value” for a type.

impl Display for Fen

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

Formats the value using the given formatter.

impl From<Fen> for Setup

fn from(fen: Fen) -> Setup

Converts to this type from the input type.

impl From<Setup> for Fen

fn from(setup: Setup) -> Fen

Converts to this type from the input type.

impl FromStr for Fen

type Err = ParseFenError

The associated error which can be returned from parsing.

fn from_str(fen: &str) -> Result<Fen, ParseFenError>

Parses a string s to return a value of this type.

impl Hash for Fen

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Fen

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Fen

impl StructuralPartialEq for Fen