stockfish 0.2.11

Light, easy-to-use wrapper for the Stockfish engine
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
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

use std::fmt;

/// The category of evaluation returned by stockfish. Either `Centipawns` or `Mate`.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum EvalType {Centipawn, Mate}

impl EvalType {

    /// Creates an [`EvalType`] from a string descriptor. The valid descriptors are:
    /// - `"cp"`, which translates to [`EvalType::Centipawn`]
    /// - `"mate"`, which translates to [`EvalType::Mate`]
    /// 
    /// # Panics
    /// 
    /// This function panics when given a string descriptor that doesn't match those listed above.
    #[must_use]
    pub fn from_descriptor(str: &str) -> EvalType {
        match str {
            "cp" => EvalType::Centipawn,
            "mate" => EvalType::Mate,
            _ => panic!("Unable to create eval type")
        }
    }
}
impl fmt::Display for EvalType {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", match self {
            EvalType::Centipawn => "cp",
            EvalType::Mate => "mate",
        })
    }
}

/// Represents the evaluation returned from the engine. Includes an [`EvalType`] and a numerical score value.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct EngineEval {
    eval_type: EvalType,
    value: i32,
}

impl EngineEval {

    #[must_use]
    pub fn new(eval_type: EvalType, value: i32) -> Self {
        Self { eval_type, value }
    }

    /// Returns an [`EvalType`] representing what type of evaluation was returned
    /// from the engine: whether the evaluation is expressed in centipawns or as
    /// mate in a certain number of moves.
    #[must_use]
    pub fn eval_type(&self) -> EvalType {
        self.eval_type
    }

    /// Returns a number representing the numerical value associated with the
    /// evaluation returned from the engine; this number is expressed in centipawns
    /// or the number of moves in which mate may be forced (depending on [`EvalType`].)
    #[must_use]
    pub fn value(&self) -> i32 {
        self.value
    }
}
impl fmt::Display for EngineEval {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let str = self.eval_type().to_string() + " " + &self.value().to_string();
        write!(f, "{str}")
    }
}