stockfish/
lib.rs

1//! `stockfish` is a light, easy-to-use wrapper library for the Stockfish chess engine.
2//! 
3//! - **Creation & Setup** — Pass the path to the binary executable to [`Stockfish::new`],
4//! then call [`Stockfish::setup_for_new_game`] to ensure that it is ready for further
5//! commands.
6//! - **Position** — Use methods like [`Stockfish::set_fen_position`] and 
7//! [`Stockfish::play_moves`] to configure the chess position that Stockfish is working with.
8//! - **Compute** — Using methods such as [`Stockfish::go`] or [`Stockfish::go_for`], 
9//! prompt Stockfish to start calculating given the current chess position.
10//! - **Output** — Accessory types have been included ([`EngineEval`], [`EvalType`], [`EngineOutput`])
11//! to structure the output from Stockfish after it has concluded its calculations.
12
13mod stockfish;
14
15mod engine_eval;
16mod engine_output;
17
18pub use crate::stockfish::Stockfish;
19pub use crate::engine_eval::{EngineEval, EvalType};
20pub use crate::engine_output::EngineOutput;