ieee80211 0.5.9

A parser for IEEE 802.11 frames.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use core::marker::PhantomData;

use scroll::{
    ctx::{MeasureWith, TryFromCtx, TryIntoCtx},
    Pwrite,
};

use crate::elements::{Element, ElementID};

use super::{EncodedRate, RatesReadIterator};

#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, Default, Hash)]
/// An element containing rates supported by the peer.
///
/// The `supported_rates` field is an [Iterator] over [super::EncodedRate]. This allows passing rates, agnostic of the collection.
/// When deserializing this struct, the Iterator is [RatesReadIterator].
pub struct ExtendedSupportedRatesElement<'a, I = RatesReadIterator<'a>>
where
    I: IntoIterator<Item = EncodedRate>,
{
    pub supported_rates: I,
    pub _phantom: PhantomData<&'a ()>,
}
impl<I: IntoIterator<Item = EncodedRate>> ExtendedSupportedRatesElement<'_, I> {
    #[doc(hidden)]
    // For internal use only.
    pub const fn new_unchecked(supported_rates: I) -> Self {
        Self {
            supported_rates,
            _phantom: PhantomData,
        }
    }
}
impl<I> ExtendedSupportedRatesElement<'_, I>
where
    I: IntoIterator<Item = EncodedRate> + Clone,
    I::IntoIter: ExactSizeIterator,
{
    /// Create a new supported rates element.
    ///
    /// This returns [None], if more than 251 rates are supplied.
    pub fn new(supported_rates: I) -> Option<Self> {
        if supported_rates.clone().into_iter().len() <= 251 {
            Some(Self::new_unchecked(supported_rates))
        } else {
            None
        }
    }
}
impl<LhsIterator, RhsIterator> PartialEq<ExtendedSupportedRatesElement<'_, RhsIterator>>
    for ExtendedSupportedRatesElement<'_, LhsIterator>
where
    LhsIterator: IntoIterator<Item = EncodedRate> + Clone,
    RhsIterator: IntoIterator<Item = EncodedRate> + Clone,
{
    fn eq(&self, other: &ExtendedSupportedRatesElement<RhsIterator>) -> bool {
        self.supported_rates
            .clone()
            .into_iter()
            .eq(other.supported_rates.clone())
    }
}
impl<I> Eq for ExtendedSupportedRatesElement<'_, I> where I: IntoIterator<Item = EncodedRate> + Clone
{}
impl<I: IntoIterator<Item = EncodedRate> + Clone> MeasureWith<()>
    for ExtendedSupportedRatesElement<'_, I>
{
    fn measure_with(&self, _ctx: &()) -> usize {
        self.supported_rates.clone().into_iter().count()
    }
}
impl<'a> TryFromCtx<'a> for ExtendedSupportedRatesElement<'a> {
    type Error = scroll::Error;
    fn try_from_ctx(from: &'a [u8], _ctx: ()) -> Result<(Self, usize), Self::Error> {
        if from.len() > 255 {
            Err(scroll::Error::TooBig {
                size: 8,
                len: from.len(),
            })
        } else {
            Ok((
                Self {
                    supported_rates: RatesReadIterator::new(from),
                    _phantom: PhantomData,
                },
                from.len(),
            ))
        }
    }
}
impl<I: IntoIterator<Item = EncodedRate>> TryIntoCtx for ExtendedSupportedRatesElement<'_, I> {
    type Error = scroll::Error;
    fn try_into_ctx(self, buf: &mut [u8], _ctx: ()) -> Result<usize, Self::Error> {
        let mut offset = 0;
        for supported_rate in self.supported_rates {
            buf.gwrite(supported_rate.0, &mut offset)?;
        }
        Ok(offset)
    }
}
impl<I: IntoIterator<Item = EncodedRate> + Clone> Element for ExtendedSupportedRatesElement<'_, I> {
    const ELEMENT_ID: ElementID = ElementID::Id(0x32);
    type ReadType<'a> = ExtendedSupportedRatesElement<'a>;
}

#[macro_export]
/// Generate an [ExtendedSupportedRatesElement].
///
/// ```
/// use ieee80211::{extended_supported_rates, rate, elements::rates::ExtendedSupportedRatesElement};
///
/// let extended_supported_rates_element = extended_supported_rates![
///     1.5,
///     2
/// ];
/// assert_eq!(extended_supported_rates_element, ExtendedSupportedRatesElement::new_unchecked([
///     rate!(1.5),
///     rate!(2)
/// ]));
/// ```
macro_rules! extended_supported_rates {
    ($(
        $rate:literal $($is_b:ident)?
    ),*) => {
        {
            use ::ieee80211::{elements::rates::{ExtendedSupportedRatesElement, EncodedRate}, rate, const_soft_float::soft_f32::SoftF32, macro_bits::{check_bit, set_bit, bit}};
            const RATE_COUNT: usize = $(
                {
                    let _ = $rate;
                    1
                } +
            )* 0;
            const RATES: [EncodedRate; RATE_COUNT] = [
                $(
                    ::ieee80211::rate!($rate $($is_b)?)
                ),*
            ];
            const _: () = {
                ::core::assert!(RATES.len() <= 251, "More than 251 rates are invalid.");
            };
            const RESULT: ExtendedSupportedRatesElement<[EncodedRate; RATE_COUNT]> = ExtendedSupportedRatesElement::new_unchecked(RATES);
            RESULT
        }
    };
}