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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
//! A library for chess move generation.
//!
//! # Examples
//!
//! Generate legal moves in the starting position:
//!
//! ```
//! use shakmaty::{Chess, Position};
//!
//! let pos = Chess::default();
//! let legals = pos.legal_moves();
//! assert_eq!(legals.len(), 20);
//! ```
//!
//! Play moves:
//!
//! ```
//! # use shakmaty::{Chess, Position};
//! use shakmaty::{Square, Move, Role};
//! #
//! # let pos = Chess::default();
//!
//! // 1. e4
//! let pos = pos.play(&Move::Normal {
//! role: Role::Pawn,
//! from: Square::E2,
//! to: Square::E4,
//! capture: None,
//! promotion: None,
//! })?;
//! # Ok::<_, shakmaty::PlayError<_>>(())
//! ```
//!
//! Detect game end conditions:
//!
//! ```
//! # use shakmaty::{Chess, Position};
//! # let pos = Chess::default();
//! assert!(!pos.is_checkmate());
//! assert!(!pos.is_stalemate());
//! assert!(!pos.is_insufficient_material());
//! assert_eq!(pos.outcome(), None); // no winner yet
//! ```
//!
//! Also supports [FEN](fen), [SAN](san) and
//! [UCI](uci) formats for positions and moves.
//!
//! # Feature flags
//!
//! * `alloc`: Enables APIs which require the
//! [`alloc`](https://doc.rust-lang.org/stable/alloc/index.html) crate
//! (e.g. FEN string rendering).
//! * `std`: Implements the
//! [`std::error::Error`](https://doc.rust-lang.org/stable/std/error/trait.Error.html)
//! trait for various errors in the crate.
//! Implies the `alloc` feature (since `std` depends on `alloc` anyway).
//! Enabled by default for convenience. For `no_std` environments, this must
//! be disabled with `default-features = false`.
//! * `variant`: Enables support for all Lichess variants.
//! * `nohash-hasher`: Implements
//! [`nohash_hasher::IsEnabled`](https://docs.rs/nohash-hasher/0.2/nohash_hasher/trait.IsEnabled.html)
//! for sensible types.
#![no_std]
#![doc(html_root_url = "https://docs.rs/shakmaty/0.27.0")]
#![forbid(unsafe_op_in_unsafe_fn)]
#![warn(missing_debug_implementations)]
#![cfg_attr(docs_rs, feature(doc_auto_cfg))]
#[cfg(feature = "alloc")]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std;
#[macro_use]
mod util;
mod bootstrap;
mod castling_side;
mod color;
mod magics;
mod movelist;
mod perft;
mod position;
mod role;
mod setup;
mod square;
mod types;
pub mod attacks;
pub mod bitboard;
pub mod board;
pub mod fen;
pub mod san;
pub mod uci;
pub mod zobrist;
#[cfg(feature = "variant")]
pub mod variant;
pub use bitboard::Bitboard;
pub use board::Board;
pub use castling_side::{ByCastlingSide, CastlingSide};
pub use color::{ByColor, Color, ParseColorError};
pub use movelist::MoveList;
pub use perft::perft;
pub use position::{
Chess, FromSetup, Outcome, ParseOutcomeError, PlayError, Position, PositionError,
PositionErrorKinds,
};
pub use role::{ByRole, Role};
pub use setup::{Castles, Setup};
pub use square::{File, ParseSquareError, Rank, Square};
pub use types::{CastlingMode, EnPassantMode, Move, Piece, RemainingChecks};
#[cfg(feature = "nohash-hasher")]
impl nohash_hasher::IsEnabled for File {}
#[cfg(feature = "nohash-hasher")]
impl nohash_hasher::IsEnabled for Rank {}
#[cfg(feature = "nohash-hasher")]
impl nohash_hasher::IsEnabled for Square {}
#[cfg(feature = "nohash-hasher")]
impl nohash_hasher::IsEnabled for Role {}
#[cfg(feature = "nohash-hasher")]
impl nohash_hasher::IsEnabled for Color {}