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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

mod custom;
mod official;
mod third_party;

use std::io::{Read, Write};

pub use custom::CustomReservedMetadataRecordObj;
pub use official::OfficialReservedMetadataRecordObj;
pub use third_party::ThirdPartyReservedMetadataRecordObj;

use crate::{
    common::traits::private::Sealed,
    v0::{
        config::Config,
        metadata::{
            error::{MetadataRecordReadError, MetadataRecordWriteError},
            traits::MetadataRecordObj,
            MetadataRecord,
        },
        tokens::{error::MetadataTokenError, MetadataToken},
        traits::WriteTo,
    },
};

/// Metadata record with identifier unknown to the library, but reserved for future use. See [specification](https://github.com/jiricekcz/fef-specification/blob/main/metadata/Metadata.md#defined-metadata-keys)
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum ReservedMetadataRecord {
    /// Official reserved metadata record.
    ///
    /// These keys are reserved for future use by the FEF specification.
    Official(OfficialReservedMetadataRecordObj),
    /// Custom reserved metadata record.
    ///
    /// These keys are reserved for custom use by any implementor.
    Custom(CustomReservedMetadataRecordObj),
    /// Third-party reserved metadata record.
    ///
    /// These keys are reserved for use by third-party extensions to the FEF specification.
    ThirdParty(ThirdPartyReservedMetadataRecordObj),
}
impl Sealed for ReservedMetadataRecord {}

impl MetadataRecordObj for ReservedMetadataRecord {
    fn token(&self) -> Result<MetadataToken, MetadataTokenError> {
        match self {
            ReservedMetadataRecord::Official(record) => record.token(),
            ReservedMetadataRecord::Custom(record) => record.token(),
            ReservedMetadataRecord::ThirdParty(record) => record.token(),
        }
    }
    fn byte_length(&self) -> usize {
        match self {
            ReservedMetadataRecord::Official(record) => record.byte_length(),
            ReservedMetadataRecord::Custom(record) => record.byte_length(),
            ReservedMetadataRecord::ThirdParty(record) => record.byte_length(),
        }
    }
}

impl ReservedMetadataRecord {
    pub(crate) fn read_from<C: ?Sized + Config, R: ?Sized + Read>(
        reader: &mut R,
        configuration: &C,
        identifier: MetadataToken,
    ) -> Result<Self, MetadataRecordReadError> {
        match identifier {
            MetadataToken::ReservedOfficial(identifier) => {
                let record = OfficialReservedMetadataRecordObj::read_from(
                    reader,
                    configuration,
                    identifier,
                )?;
                Ok(ReservedMetadataRecord::Official(record))
            }
            MetadataToken::ReservedThirdParty(identifier) => {
                let record = ThirdPartyReservedMetadataRecordObj::read_from(
                    reader,
                    configuration,
                    identifier,
                )?;
                Ok(ReservedMetadataRecord::ThirdParty(record))
            }
            MetadataToken::ReservedCustom(identifier) => {
                let record =
                    CustomReservedMetadataRecordObj::read_from(reader, configuration, identifier)?;
                Ok(ReservedMetadataRecord::Custom(record))
            }
            _ => unreachable!(),
        }
    }

    pub(crate) fn identifier(&self) -> u32 {
        match self {
            ReservedMetadataRecord::Official(record) => record.identifier,
            ReservedMetadataRecord::Custom(record) => record.identifier,
            ReservedMetadataRecord::ThirdParty(record) => record.identifier,
        }
    }
}

impl<W: ?Sized + Write> WriteTo<W> for ReservedMetadataRecord {
    type WriteError = MetadataRecordWriteError;
    fn write_to<C: ?Sized + Config>(
        &self,
        writer: &mut W,
        configuration: &C,
    ) -> Result<(), Self::WriteError> {
        match self {
            ReservedMetadataRecord::Official(record) => record.write_to(writer, configuration),
            ReservedMetadataRecord::Custom(record) => record.write_to(writer, configuration),
            ReservedMetadataRecord::ThirdParty(record) => record.write_to(writer, configuration),
        }
    }
}

impl Into<MetadataRecord> for ReservedMetadataRecord {
    fn into(self) -> MetadataRecord {
        MetadataRecord::Reserved(self)
    }
}