Skip to main content

hyper_cors/
vary.rs

1//! Configuration for the `Vary` response header.
2//!
3//! The set of names is derived from the other CORS knobs unless the user pins it via
4//! [`CorsBuilder::vary`].
5//!
6//! [`CorsBuilder::vary`]: crate::CorsBuilder::vary
7
8use http::header::{
9    self, HeaderName, HeaderValue, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD,
10    ORIGIN,
11};
12
13/// Configuration for the `Vary` header.
14///
15/// The joined value is computed once at construction; the set of names never changes after
16/// [`crate::CorsBuilder::build`].
17#[derive(Clone, Debug)]
18#[must_use]
19pub struct Vary(Option<HeaderValue>);
20
21impl Vary {
22    /// Sets the list of header names returned in `Vary`.
23    pub fn list<I>(headers: I) -> Self
24    where
25        I: IntoIterator<Item = HeaderName>,
26    {
27        Self(join_names(headers))
28    }
29
30    pub(crate) fn to_header(&self) -> Option<(HeaderName, HeaderValue)> {
31        self.0.clone().map(|v| (header::VARY, v))
32    }
33
34    /// Returns the default set of header names.
35    pub(crate) fn default_header_names() -> Vec<HeaderName> {
36        vec![
37            ORIGIN,
38            ACCESS_CONTROL_REQUEST_METHOD,
39            ACCESS_CONTROL_REQUEST_HEADERS,
40        ]
41    }
42}
43
44impl Default for Vary {
45    fn default() -> Self {
46        Self::list(Self::default_header_names())
47    }
48}
49
50fn join_names<I>(headers: I) -> Option<HeaderValue>
51where
52    I: IntoIterator<Item = HeaderName>,
53{
54    let mut iter = headers.into_iter();
55    let first = iter.next()?;
56    let mut buf = Vec::with_capacity(64);
57    buf.extend_from_slice(first.as_str().as_bytes());
58    for name in iter {
59        buf.extend_from_slice(b", ");
60        buf.extend_from_slice(name.as_str().as_bytes());
61    }
62    Some(
63        HeaderValue::from_bytes(&buf)
64            .expect("comma-separated list of header names is always a valid HeaderValue"),
65    )
66}
67
68impl<const N: usize> From<[HeaderName; N]> for Vary {
69    fn from(arr: [HeaderName; N]) -> Self {
70        Self::list(arr)
71    }
72}
73
74impl From<Vec<HeaderName>> for Vary {
75    fn from(vec: Vec<HeaderName>) -> Self {
76        Self::list(vec)
77    }
78}