barse 0.3.0

Binary parsing library.
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

use std::{
    any::{Any, TypeId},
    ops::{Deref, DerefMut},
};

use crate::{error::Error, ByteRead, Endian, Result};

use super::DynamicByteReader;

/// [`ByteRead`] wrapper that can give a set of flags.
#[derive(Debug, Clone, Copy)]
pub struct FlagByteReader<'flags, R, const SIZE: usize>(R, [(TypeId, &'flags dyn Any); SIZE]);

impl<'flags, R, const SIZE: usize> FlagByteReader<'flags, R, SIZE> {
    /// Wrap a [`ByteRead`] yo use the given flags and fall back on it's own if any.
    pub fn new<'input>(reader: R, flags: [&'flags dyn Any; SIZE]) -> Self
    where
        R: ByteRead<'input>,
    {
        Self(reader, flags.map(|flag| (flag.type_id(), flag)))
    }

    /// All flags set on this [`FlagByteReader`].
    pub fn all_flags(&self) -> [&'flags dyn Any; SIZE] {
        self.1.map(|flag| flag.1)
    }

    /// Consume self and return the wrapped [`ByteRead`].
    pub fn into_inner(self) -> R {
        self.0
    }
}

impl<'flags, R, const SIZE: usize> Deref for FlagByteReader<'flags, R, SIZE> {
    type Target = R;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<'flags, R, const SIZE: usize> DerefMut for FlagByteReader<'flags, R, SIZE> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<'flags, R, const SIZE: usize> AsRef<R> for FlagByteReader<'flags, R, SIZE> {
    fn as_ref(&self) -> &R {
        &self.0
    }
}

#[deny(clippy::missing_trait_methods)]
impl<'input, 'flags, R, const SIZE: usize> ByteRead<'input> for FlagByteReader<'flags, R, SIZE>
where
    R: ByteRead<'input>,
    'flags: 'input,
{
    type AtByteRead = FlagByteReader<'input, R::AtByteRead, SIZE>;
    fn read_ref(&mut self, count: usize) -> Result<&'input [u8]> {
        self.0.read_ref(count)
    }

    fn remaining(&mut self) -> Result<&'input [u8]> {
        self.0.remaining()
    }

    fn read<const COUNT: usize>(&mut self) -> Result<[u8; COUNT]> {
        self.0.read::<COUNT>()
    }

    fn endian(&self) -> Endian {
        self.0.endian()
    }

    fn flag<T>(&self) -> Result<&T>
    where
        T: Any,
    {
        let type_id = TypeId::of::<T>();
        for (id, val) in &self.1 {
            if type_id == *id {
                return val
                    .downcast_ref::<T>()
                    .ok_or_else(Error::flag_not_found::<T>);
            }
        }

        // In case the flag was not found the wrapped reader is queried.
        self.0.flag::<T>()
    }

    fn get_flag(&self, type_id: std::any::TypeId) -> Option<&dyn std::any::Any> {
        for (id, val) in &self.1 {
            if type_id == *id {
                return Some(*val);
            }
        }

        // In case the flag was not found the wrapped reader is queried.
        self.0.get_flag(type_id)
    }

    fn all(&self) -> Result<&'input [u8]> {
        self.0.all()
    }

    fn at(&self, location: usize) -> Result<Self::AtByteRead> {
        Ok(FlagByteReader(self.0.at(location)?, self.1))
    }

    fn into_dynamic(self) -> DynamicByteReader<'input>
    where
        Self: Sized + 'input,
    {
        DynamicByteReader::from_reader(self)
    }
}