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
use rama_http_types::HeaderValue;
/// `Upgrade` header, defined in [RFC7230](https://datatracker.ietf.org/doc/html/rfc7230#section-6.7)
///
/// The `Upgrade` header field is intended to provide a simple mechanism
/// for transitioning from HTTP/1.1 to some other protocol on the same
/// connection. A client MAY send a list of protocols in the Upgrade
/// header field of a request to invite the server to switch to one or
/// more of those protocols, in order of descending preference, before
/// sending the final response. A server MAY ignore a received Upgrade
/// header field if it wishes to continue using the current protocol on
/// that connection. Upgrade cannot be used to insist on a protocol
/// change.
///
/// ## ABNF
///
/// ```text
/// Upgrade = 1#protocol
///
/// protocol = protocol-name ["/" protocol-version]
/// protocol-name = token
/// protocol-version = token
/// ```
///
/// ## Example values
///
/// * `HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11`
///
/// # Note
///
/// In practice, the `Upgrade` header is never that complicated. In most cases,
/// it is only ever a single value, such as `"websocket"`.
///
/// # Examples
///
/// ```
/// use rama_http_headers::Upgrade;
///
/// let ws = Upgrade::websocket();
/// ```
#[derive(Clone, Debug, PartialEq)]
pub struct Upgrade(HeaderValue);
derive_header! {
Upgrade(_),
name: UPGRADE
}
impl Upgrade {
#[inline]
pub fn as_bytes(&self) -> &[u8] {
self.0.as_ref()
}
}
impl AsRef<[u8]> for Upgrade {
#[inline]
fn as_ref(&self) -> &[u8] {
self.0.as_ref()
}
}
impl Upgrade {
/// Constructs an `Upgrade: websocket` header.
#[must_use]
pub fn websocket() -> Self {
Self(HeaderValue::from_static("websocket"))
}
/// Returns true if this is an `Upgrade: websocket` header.
pub fn is_websocket(&self) -> bool {
self.0
.as_bytes()
.trim_ascii()
.eq_ignore_ascii_case(b"websocket")
}
}