File: priority.rs

package info (click to toggle)
firefox 147.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,320 kB
  • sloc: cpp: 7,607,359; javascript: 6,533,295; ansic: 3,775,223; python: 1,415,500; xml: 634,561; asm: 438,949; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (240 lines) | stat: -rw-r--r-- 7,091 bytes parent folder | download | duplicates (4)
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// This example demonstrates both dictionary- and visitor-based parsing of the
// Priority header according to https://httpwg.org/specs/rfc9218.html.

const KEY_U: &str = "u";
const KEY_I: &str = "i";

const DEFAULT_URGENCY: u8 = 3;
const DEFAULT_INCREMENTAL: bool = false;

#[derive(Debug, PartialEq)]
struct Priority {
    urgency: u8,
    incremental: bool,
}

impl Default for Priority {
    fn default() -> Self {
        Self {
            urgency: DEFAULT_URGENCY,
            incremental: DEFAULT_INCREMENTAL,
        }
    }
}

fn parse_urgency(v: Option<sfv::Integer>) -> u8 {
    v.and_then(|v| u8::try_from(v).ok())
        .filter(|v| *v <= 7)
        .unwrap_or(DEFAULT_URGENCY)
}

fn parse_incremental(v: Option<bool>) -> bool {
    v.unwrap_or(DEFAULT_INCREMENTAL)
}

impl<'de> sfv::visitor::DictionaryVisitor<'de> for Priority {
    type Error = std::convert::Infallible;

    fn entry(
        &mut self,
        key: &'de sfv::KeyRef,
    ) -> Result<impl sfv::visitor::EntryVisitor<'de>, Self::Error> {
        Ok(match key.as_str() {
            KEY_U => Some(PriorityParameter::U(&mut self.urgency)),
            KEY_I => Some(PriorityParameter::I(&mut self.incremental)),
            // Per https://httpwg.org/specs/rfc9218.html#parameters unknown
            // dictionary keys are ignored.
            _ => None,
        })
    }
}

enum PriorityParameter<'a> {
    U(&'a mut u8),
    I(&'a mut bool),
}

impl<'de> sfv::visitor::ItemVisitor<'de> for PriorityParameter<'_> {
    type Error = std::convert::Infallible;

    fn bare_item(
        self,
        bare_item: sfv::BareItemFromInput<'de>,
    ) -> Result<impl sfv::visitor::ParameterVisitor<'de>, Self::Error> {
        // Per https://httpwg.org/specs/rfc9218.html#parameters values of
        // unexpected types and out-of-range values are ignored. Since the same
        // dictionary key can appear multiple times in the input, and only the
        // last value may be considered per Structured Field semantics, we
        // overwrite any existing value with the default on error.
        match self {
            Self::U(urgency) => *urgency = parse_urgency(bare_item.as_integer()),
            Self::I(incremental) => *incremental = parse_incremental(bare_item.as_boolean()),
        }
        // Neither https://httpwg.org/specs/rfc9218.html#urgency nor
        // https://httpwg.org/specs/rfc9218.html#incremental defines parameters.
        Ok(sfv::visitor::Ignored)
    }
}

impl<'de> sfv::visitor::EntryVisitor<'de> for PriorityParameter<'_> {
    fn inner_list(self) -> Result<impl sfv::visitor::InnerListVisitor<'de>, Self::Error> {
        // Per https://httpwg.org/specs/rfc9218.html#parameters values of
        // unexpected types are ignored. Since the same dictionary key can
        // appear multiple times in the input, and only the last value may be
        // considered per Structured Field semantics, we overwrite any existing
        // value with the default.
        match self {
            Self::U(urgency) => *urgency = DEFAULT_URGENCY,
            Self::I(incremental) => *incremental = DEFAULT_INCREMENTAL,
        }
        // Per https://httpwg.org/specs/rfc9218.html#parameters values of
        // unexpected types are ignored.
        Ok(sfv::visitor::Ignored)
    }
}

impl From<&sfv::Dictionary> for Priority {
    fn from(dict: &sfv::Dictionary) -> Self {
        Self {
            urgency: parse_urgency(match dict.get(KEY_U) {
                Some(sfv::ListEntry::Item(sfv::Item { bare_item, .. })) => bare_item.as_integer(),
                _ => None,
            }),
            incremental: parse_incremental(match dict.get(KEY_I) {
                Some(sfv::ListEntry::Item(sfv::Item { bare_item, .. })) => bare_item.as_boolean(),
                _ => None,
            }),
        }
    }
}

#[allow(clippy::too_many_lines)]
fn main() -> Result<(), sfv::Error> {
    let examples = [
        // From https://httpwg.org/specs/rfc9218.html#parameters: "When
        // receiving an HTTP request that does not carry these priority
        // parameters, a server SHOULD act as if their default values were
        // specified."
        (
            "",
            Priority {
                urgency: 3,
                incremental: false,
            },
        ),
        // https://httpwg.org/specs/rfc9218.html#incremental
        (
            "u=5, i",
            Priority {
                urgency: 5,
                incremental: true,
            },
        ),
        // Unknown key
        (
            "x;a, u=5, i",
            Priority {
                urgency: 5,
                incremental: true,
            },
        ),
        // Unexpected type for urgency
        (
            "u=(), i",
            Priority {
                urgency: 3,
                incremental: true,
            },
        ),
        // Unexpected type for urgency
        (
            "u=6.5, i",
            Priority {
                urgency: 3,
                incremental: true,
            },
        ),
        // Urgency below minimum
        (
            "u=-1, i",
            Priority {
                urgency: 3,
                incremental: true,
            },
        ),
        // Urgency above maximum
        (
            "u=8, i",
            Priority {
                urgency: 3,
                incremental: true,
            },
        ),
        // Unexpected type for incremental
        (
            "i=(), u=5",
            Priority {
                urgency: 5,
                incremental: false,
            },
        ),
        // Unexpected type for incremental
        (
            "i=1, u=5",
            Priority {
                urgency: 5,
                incremental: false,
            },
        ),
        // Parameters are ignored
        (
            "u=5;x, i;y",
            Priority {
                urgency: 5,
                incremental: true,
            },
        ),
        // When duplicate keys are encountered, only last's value is used
        (
            "u=6, i, u=5, i=?0",
            Priority {
                urgency: 5,
                incremental: false,
            },
        ),
        // When duplicate keys are encountered, only last's value is used
        (
            "u=6, i, u=(), i=()",
            Priority {
                urgency: 3,
                incremental: false,
            },
        ),
    ];

    for (input, expected) in examples {
        assert_eq!(
            Priority::from(
                &sfv::Parser::new(input)
                    .with_version(sfv::Version::Rfc8941)
                    .parse()?
            ),
            expected,
            "{input}"
        );

        assert_eq!(
            {
                let mut priority = Priority::default();
                sfv::Parser::new(input)
                    .with_version(sfv::Version::Rfc8941)
                    .parse_dictionary_with_visitor(&mut priority)?;
                priority
            },
            expected,
            "{input}"
        );
    }

    Ok(())
}