flour 2.0.1

Serializes and deserializes BCCAD / BRCAD files to and from JSON
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
70
71
72
73
74

use thiserror::Error;

/// Result type for flour
pub type Result<T> = std::result::Result<T, Error>;

/// Error type for flour
#[derive(Error, Debug)]
pub enum Error {
    /// Error passed from std::io
    #[error("System error: {0}")]
    IOError(std::io::Error),

    /// Error passed from semver crate
    #[error("Error parsing version: {0}")]
    SemverError(semver::Error),

    #[error("Error when parsing string: {0}")]
    StringUtf8Error(std::string::FromUtf8Error),

    /// Error called when option `--labels` is given to a non-BRCAD file
    #[error("--labels can only be used for BRCAD files")]
    LabelsOnNotBRCAD,

    #[error("Tried to use {0}, which is not implemented yet")]
    NonImplementedFeature(String),

    /// BRCAD labels file is invalid
    #[error("Failed to parse labels file")]
    BadLabelsFile,

    /// BRCAD labels file is not Shift-JIS
    #[error("Could not decode labels file from Shift-JIS!")]
    LabelsFileNotShiftJIS,

    /// Interpreting a BXCADWrapper from an incompatible version
    #[error(
        "This file was made with an incompatible flour version: {0}\n\
        flour can read files made from version {} up to the current version",
        crate::bxcad::OLDEST_SUPPORTED_VERSION
    )]
    IncompatibleVersion(semver::Version),

    /// File is not a BXCAD
    #[error("File given is not a known BXCAD file")]
    NotBXCAD,

    /// File is not a flour JSON
    #[error("File given is not a flour JSON file")]
    NotFlour,
}

impl From<std::io::Error> for Error {
    fn from(err: std::io::Error) -> Self {
        Self::IOError(err)
    }
}

impl From<std::string::FromUtf8Error> for Error {
    fn from(err: std::string::FromUtf8Error) -> Self {
        Self::StringUtf8Error(err)
    }
}

impl From<serde_json::Error> for Error {
    fn from(err: serde_json::Error) -> Self {
        Self::IOError(std::io::Error::from(err))
    }
}

impl From<semver::Error> for Error {
    fn from(err: semver::Error) -> Self {
        Self::SemverError(err)
    }
}