fef 0.2.3

Rust implementation of a parser of the FEF format
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
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

//! Error types for metadata module.
use std::{convert::Infallible, fmt::Debug};

use thiserror::Error;

use crate::v0::{
    raw::error::{StringReadError, StringWriteError, VariableLengthEnumError},
    tokens::error::MetadataTokenError,
};

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum MetadataRecordReadError {
    #[error("failed to read a string")]
    StringReadError(#[from] StringReadError),
    #[error("failed to read a variable length enum")]
    LengthReadError(#[from] VariableLengthEnumError),
    #[error("failed to read unspecified data")]
    PureDataReadError(#[from] std::io::Error),
    #[error("failed to read a metadata token")]
    TokenReadError(#[from] MetadataTokenError),
}

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum MetadataRecordWriteError {
    #[error("failed to write a string")]
    StringWriteError(#[from] StringWriteError),
    #[error("failed to write a variable length enum")]
    LengthWriteError(#[from] VariableLengthEnumError),
    #[error("failed to write unspecified data")]
    PureDataWriteError(#[from] std::io::Error),
}

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum MetadataHeaderReadError {
    #[error("failed to read the number of records in metadata")]
    RecordCountError(VariableLengthEnumError),
    #[error("failed to read byte length of metadata records")]
    ByteLengthError(VariableLengthEnumError),
}

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum MetadataHeaderWriteError {
    #[error("failed to write the number of records in metadata")]
    RecordCountError(VariableLengthEnumError),
    #[error("failed to write byte length of metadata records")]
    ByteLengthError(VariableLengthEnumError),
}

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum MetadataWriteError {
    #[error("failed to write metadata header")]
    HeaderError(#[from] MetadataHeaderWriteError),
    #[error("failed to write metadata record")]
    RecordError(#[from] MetadataRecordWriteError),
}

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum MetadataReadError {
    #[error("failed to read metadata header")]
    HeaderError(#[from] MetadataHeaderReadError),
    #[error("failed to read metadata record")]
    RecordError(#[from] MetadataRecordReadError),
}

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum FromIteratorMetadataWriteError<E: std::error::Error + Debug> {
    #[error("an error occurred in user provided iterator")]
    IteratorError(E),
    #[error("an error occurred while writing metadata")]
    MetadataWriteError(#[from] MetadataWriteError),
}

#[derive(Error, Debug)]
#[error("metadata identifier {identifier} is out of range [{}..={}]", range.start(), range.end())]
pub struct MetadataIdentifierOutOfRangeError {
    pub identifier: u32,
    pub range: std::ops::RangeInclusive<u32>,
}

impl MetadataIdentifierOutOfRangeError {
    pub(crate) fn custom_key(identifier: u32) -> Self {
        Self {
            identifier,
            range: 0x100000..=0x1FFFFF,
        }
    }
}

impl<E: std::error::Error> From<Infallible> for FromIteratorMetadataWriteError<E> {
    fn from(_: Infallible) -> Self {
        unreachable!()
    }
}