chess-lab 0.2.1

Chess library with multiple variants and FEN/PGN support.
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

use thiserror::Error;

use super::FenError;

/// An error that occurs when parsing a PGN string
///
#[non_exhaustive]
#[derive(Debug, Error)]
pub enum PGNError {
    /// The FEN string is invalid
    #[error("Invalid FEN: {0}")]
    InvalidFen(#[from] FenError),
    /// The PGN string is invalid
    #[error("Invalid PGN: {0}")]
    InvalidPgn(String),
    /// The file does not exist
    #[error("No such file or directory: {0}")]
    NoSuchFile(#[from] std::io::Error),
    /// The metadata is invalid
    #[error("Invalid or not supported metadata: {0}")]
    InvalidMetadata(#[from] PGNMetadataError),
    /// The variant does not exists
    #[error("Invalid or not variant provided: {0}")]
    InvalidVariant(String),
}

/// An error that occurs when parsing PGN metadata
///
/// # Attributes
/// * `metadata` - The metadata that caused the error
///
#[derive(Debug, Error)]
#[error("Invalid or not supported metadata: {metadata}")]
pub struct PGNMetadataError {
    /// The metadata key/value that caused the error
    pub metadata: String,
}

impl PGNMetadataError {
    /// Creates a new [PGNMetadataError] with the given metadata
    ///
    /// # Arguments
    /// * `metadata` - The metadata that caused the error
    ///
    /// # Example
    /// ```
    /// # use chess_lab::errors::PGNMetadataError;
    /// let error = PGNMetadataError::new("Invalid metadata".to_string());
    /// ```
    ///
    pub fn new(metadata: String) -> Self {
        PGNMetadataError { metadata }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_pgn_metadata_error_new() {
        let metadata = "Invalid metadata".to_string();
        let error = PGNMetadataError::new(metadata.clone());
        assert_eq!(error.metadata, metadata);
    }
}