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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
use std::collections::{self, hash_map, hash_map::Entry, VecDeque};
use crate::{HeaderName, HeaderValue};
type HashMap<K, V> = collections::HashMap<K, V, fxhash::FxBuildHasher>;
/// Combines two different futures, streams, or sinks having the same associated types into a single
/// type.
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum Either<A, B> {
/// First branch of the type
Left(A),
/// Second branch of the type
Right(B),
}
/// A set of HTTP headers
///
/// `HeaderMap` is an multimap of [`HeaderName`] to values.
///
/// [`HeaderName`]: struct.HeaderName.html
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct HeaderMap {
pub(crate) inner: HashMap<HeaderName, Value>,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Value {
One(HeaderValue),
Multi(VecDeque<HeaderValue>),
}
impl Value {
fn get(&self) -> &HeaderValue {
match self {
Value::One(ref val) => val,
Value::Multi(ref val) => &val[0],
}
}
fn get_mut(&mut self) -> &mut HeaderValue {
match self {
Value::One(ref mut val) => val,
Value::Multi(ref mut val) => &mut val[0],
}
}
pub(crate) fn append(&mut self, val: HeaderValue) {
match self {
Value::One(prev_val) => {
let prev_val = std::mem::replace(prev_val, val);
let mut val = VecDeque::new();
val.push_back(prev_val);
let data = std::mem::replace(self, Value::Multi(val));
match data {
Value::One(val) => self.append(val),
Value::Multi(_) => unreachable!(),
}
}
Value::Multi(ref mut vec) => vec.push_back(val),
}
}
}
#[derive(Debug)]
pub struct ValueIntoIter {
value: Value,
}
impl Iterator for ValueIntoIter {
type Item = HeaderValue;
fn next(&mut self) -> Option<Self::Item> {
match &mut self.value {
Value::One(_) => {
let val = std::mem::replace(
&mut self.value,
Value::Multi(VecDeque::with_capacity(0)),
);
match val {
Value::One(val) => Some(val),
_ => unreachable!(),
}
}
Value::Multi(vec) => vec.pop_front(),
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
match self.value {
Value::One(_) => (1, None),
Value::Multi(ref v) => v.iter().size_hint(),
}
}
}
impl IntoIterator for Value {
type Item = HeaderValue;
type IntoIter = ValueIntoIter;
#[inline]
fn into_iter(self) -> Self::IntoIter {
ValueIntoIter { value: self }
}
}
impl Extend<HeaderValue> for Value {
#[inline]
fn extend<T>(&mut self, iter: T)
where
T: IntoIterator<Item = HeaderValue>,
{
for h in iter.into_iter() {
self.append(h);
}
}
}
impl From<HeaderValue> for Value {
#[inline]
fn from(hdr: HeaderValue) -> Value {
Value::One(hdr)
}
}
impl<'a> From<&'a HeaderValue> for Value {
#[inline]
fn from(hdr: &'a HeaderValue) -> Value {
Value::One(hdr.clone())
}
}
impl Default for HeaderMap {
#[inline]
fn default() -> Self {
Self::new()
}
}
impl HeaderMap {
/// Create an empty `HeaderMap`.
///
/// The map will be created without any capacity. This function will not
/// allocate.
pub fn new() -> Self {
HeaderMap {
inner: HashMap::default(),
}
}
/// Create an empty `HeaderMap` with the specified capacity.
///
/// The returned map will allocate internal storage in order to hold about
/// `capacity` elements without reallocating. However, this is a "best
/// effort" as there are usage patterns that could cause additional
/// allocations before `capacity` headers are stored in the map.
///
/// More capacity than requested may be allocated.
pub fn with_capacity(capacity: usize) -> HeaderMap {
HeaderMap {
inner: HashMap::with_capacity_and_hasher(capacity, Default::default()),
}
}
/// Returns the number of keys stored in the map.
///
/// This number could be be less than or equal to actual headers stored in
/// the map.
pub fn len(&self) -> usize {
self.inner.len()
}
/// Returns true if the map contains no elements.
pub fn is_empty(&self) -> bool {
self.inner.len() == 0
}
/// Clears the map, removing all key-value pairs. Keeps the allocated memory
/// for reuse.
pub fn clear(&mut self) {
self.inner.clear();
}
/// Returns the number of headers the map can hold without reallocating.
///
/// This number is an approximation as certain usage patterns could cause
/// additional allocations before the returned capacity is filled.
pub fn capacity(&self) -> usize {
self.inner.capacity()
}
/// Reserves capacity for at least `additional` more headers to be inserted
/// into the `HeaderMap`.
///
/// The header map may reserve more space to avoid frequent reallocations.
/// Like with `with_capacity`, this will be a "best effort" to avoid
/// allocations until `additional` more headers are inserted. Certain usage
/// patterns could cause additional allocations before the number is
/// reached.
pub fn reserve(&mut self, additional: usize) {
self.inner.reserve(additional)
}
/// Returns a reference to the value associated with the key.
///
/// If there are multiple values associated with the key, then the first one
/// is returned. Use `get_all` to get all values associated with a given
/// key. Returns `None` if there are no values associated with the key.
pub fn get<N: AsName>(&self, name: N) -> Option<&HeaderValue> {
self.get2(name).map(|v| v.get())
}
fn get2<N: AsName>(&self, name: N) -> Option<&Value> {
match name.as_name() {
Either::Left(name) => self.inner.get(name),
Either::Right(s) => {
if let Ok(name) = HeaderName::try_from(s) {
self.inner.get(&name)
} else {
None
}
}
}
}
/// Returns a view of all values associated with a key.
///
/// The returned view does not incur any allocations and allows iterating
/// the values associated with the key. See [`GetAll`] for more details.
/// Returns `None` if there are no values associated with the key.
///
/// [`GetAll`]: struct.GetAll.html
pub fn get_all<N: AsName>(&self, name: N) -> GetAll<'_> {
GetAll {
idx: 0,
item: self.get2(name),
}
}
/// Returns a mutable reference to the value associated with the key.
///
/// If there are multiple values associated with the key, then the first one
/// is returned. Use `entry` to get all values associated with a given
/// key. Returns `None` if there are no values associated with the key.
pub fn get_mut<N: AsName>(&mut self, name: N) -> Option<&mut HeaderValue> {
match name.as_name() {
Either::Left(name) => self.inner.get_mut(name).map(|v| v.get_mut()),
Either::Right(s) => {
if let Ok(name) = HeaderName::try_from(s) {
self.inner.get_mut(&name).map(|v| v.get_mut())
} else {
None
}
}
}
}
/// Returns true if the map contains a value for the specified key.
pub fn contains_key<N: AsName>(&self, key: N) -> bool {
match key.as_name() {
Either::Left(name) => self.inner.contains_key(name),
Either::Right(s) => {
if let Ok(name) = HeaderName::try_from(s) {
self.inner.contains_key(&name)
} else {
false
}
}
}
}
/// An iterator visiting all key-value pairs.
///
/// The iteration order is arbitrary, but consistent across platforms for
/// the same crate version. Each key will be yielded once per associated
/// value. So, if a key has 3 associated values, it will be yielded 3 times.
pub fn iter(&self) -> Iter<'_> {
Iter::new(self.inner.iter())
}
#[doc(hidden)]
pub fn iter_inner(&self) -> hash_map::Iter<'_, HeaderName, Value> {
self.inner.iter()
}
/// An iterator visiting all keys.
///
/// The iteration order is arbitrary, but consistent across platforms for
/// the same crate version. Each key will be yielded only once even if it
/// has multiple associated values.
pub fn keys(&self) -> Keys<'_> {
Keys(self.inner.keys())
}
/// Inserts a key-value pair into the map.
///
/// If the map did not previously have this key present, then `None` is
/// returned.
///
/// If the map did have this key present, the new value is associated with
/// the key and all previous values are removed. **Note** that only a single
/// one of the previous values is returned. If there are multiple values
/// that have been previously associated with the key, then the first one is
/// returned. See `insert_mult` on `OccupiedEntry` for an API that returns
/// all values.
///
/// The key is not updated, though; this matters for types that can be `==`
/// without being identical.
pub fn insert(&mut self, key: HeaderName, val: HeaderValue) {
let _ = self.inner.insert(key, Value::One(val));
}
/// Inserts a key-value pair into the map.
///
/// If the map did not previously have this key present, then `false` is
/// returned.
///
/// If the map did have this key present, the new value is pushed to the end
/// of the list of values currently associated with the key. The key is not
/// updated, though; this matters for types that can be `==` without being
/// identical.
pub fn append(&mut self, key: HeaderName, value: HeaderValue) {
match self.inner.entry(key) {
Entry::Occupied(mut entry) => entry.get_mut().append(value),
Entry::Vacant(entry) => {
entry.insert(Value::One(value));
}
}
}
/// Removes all headers for a particular header name from the map.
pub fn remove<N: AsName>(&mut self, key: N) {
match key.as_name() {
Either::Left(name) => {
let _ = self.inner.remove(name);
}
Either::Right(s) => {
if let Ok(name) = HeaderName::try_from(s) {
let _ = self.inner.remove(&name);
}
}
}
}
}
#[doc(hidden)]
pub trait AsName {
fn as_name(&self) -> Either<&HeaderName, &str>;
}
impl AsName for HeaderName {
fn as_name(&self) -> Either<&HeaderName, &str> {
Either::Left(self)
}
}
impl<'a> AsName for &'a HeaderName {
fn as_name(&self) -> Either<&HeaderName, &str> {
Either::Left(self)
}
}
impl<'a> AsName for &'a str {
fn as_name(&self) -> Either<&HeaderName, &str> {
Either::Right(self)
}
}
impl AsName for String {
fn as_name(&self) -> Either<&HeaderName, &str> {
Either::Right(self.as_str())
}
}
impl<'a> AsName for &'a String {
fn as_name(&self) -> Either<&HeaderName, &str> {
Either::Right(self.as_str())
}
}
impl<N: std::fmt::Display, V> FromIterator<(N, V)> for HeaderMap
where
HeaderName: TryFrom<N>,
Value: TryFrom<V>,
V: std::fmt::Debug,
{
#[inline]
#[allow(clippy::mutable_key_type)]
fn from_iter<T: IntoIterator<Item = (N, V)>>(iter: T) -> Self {
let map = iter
.into_iter()
.filter_map(|(n, v)| {
let name = format!("{}", n);
match (HeaderName::try_from(n), Value::try_from(v)) {
(Ok(n), Ok(v)) => Some((n, v)),
(Ok(n), Err(_)) => {
log::warn!("failed to parse `{}` header value", n);
None
}
(Err(_), Ok(_)) => {
log::warn!("invalid HTTP header name: {}", name);
None
}
(Err(_), Err(_)) => {
log::warn!("invalid HTTP header name `{}` and value", name);
None
}
}
})
.fold(HashMap::default(), |mut map: HashMap<_, Value>, (n, v)| {
match map.entry(n) {
Entry::Occupied(mut oc) => oc.get_mut().extend(v),
Entry::Vacant(va) => {
let _ = va.insert(v);
}
}
map
});
HeaderMap { inner: map }
}
}
impl FromIterator<HeaderValue> for Value {
fn from_iter<T: IntoIterator<Item = HeaderValue>>(iter: T) -> Self {
let mut iter = iter.into_iter();
let value = iter.next().map(Value::One);
let mut value = match value {
Some(v) => v,
_ => Value::One(HeaderValue::from_static("")),
};
value.extend(iter);
value
}
}
impl TryFrom<&str> for Value {
type Error = crate::header::InvalidHeaderValue;
fn try_from(value: &str) -> Result<Self, Self::Error> {
Ok(value
.split(',')
.filter(|v| !v.is_empty())
.map(|v| v.trim())
.filter_map(|v| HeaderValue::from_str(v).ok())
.collect::<Value>())
}
}
#[derive(Debug)]
pub struct GetAll<'a> {
idx: usize,
item: Option<&'a Value>,
}
impl<'a> Iterator for GetAll<'a> {
type Item = &'a HeaderValue;
#[inline]
fn next(&mut self) -> Option<&'a HeaderValue> {
if let Some(ref val) = self.item {
match val {
Value::One(ref val) => {
self.item.take();
Some(val)
}
Value::Multi(ref vec) => {
if self.idx < vec.len() {
let item = Some(&vec[self.idx]);
self.idx += 1;
item
} else {
self.item.take();
None
}
}
}
} else {
None
}
}
}
#[derive(Debug)]
pub struct Keys<'a>(hash_map::Keys<'a, HeaderName, Value>);
impl<'a> Iterator for Keys<'a> {
type Item = &'a HeaderName;
#[inline]
fn next(&mut self) -> Option<&'a HeaderName> {
self.0.next()
}
}
impl<'a> IntoIterator for &'a HeaderMap {
type Item = (&'a HeaderName, &'a HeaderValue);
type IntoIter = Iter<'a>;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
#[derive(Debug)]
pub struct Iter<'a> {
idx: usize,
current: Option<(&'a HeaderName, &'a VecDeque<HeaderValue>)>,
iter: hash_map::Iter<'a, HeaderName, Value>,
}
impl<'a> Iter<'a> {
fn new(iter: hash_map::Iter<'a, HeaderName, Value>) -> Self {
Self {
iter,
idx: 0,
current: None,
}
}
}
impl<'a> Iterator for Iter<'a> {
type Item = (&'a HeaderName, &'a HeaderValue);
#[inline]
fn next(&mut self) -> Option<(&'a HeaderName, &'a HeaderValue)> {
if let Some(ref mut item) = self.current {
if self.idx < item.1.len() {
let item = (item.0, &item.1[self.idx]);
self.idx += 1;
return Some(item);
} else {
self.idx = 0;
self.current.take();
}
}
if let Some(item) = self.iter.next() {
match item.1 {
Value::One(ref value) => Some((item.0, value)),
Value::Multi(ref vec) => {
self.current = Some((item.0, vec));
self.next()
}
}
} else {
None
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::header::{ACCEPT_ENCODING, CONTENT_TYPE};
#[test]
fn test_from_iter() {
let vec = vec![
("Connection", "keep-alive"),
("Accept", "text/html"),
(
"Accept",
"*/*, application/xhtml+xml, application/xml;q=0.9, image/webp,",
),
];
let map = HeaderMap::from_iter(vec);
assert_eq!(
map.get("Connection"),
Some(&HeaderValue::from_static("keep-alive"))
);
assert_eq!(
map.get_all("Accept").collect::<Vec<&HeaderValue>>(),
vec![
&HeaderValue::from_static("text/html"),
&HeaderValue::from_static("*/*"),
&HeaderValue::from_static("application/xhtml+xml"),
&HeaderValue::from_static("application/xml;q=0.9"),
&HeaderValue::from_static("image/webp"),
]
)
}
#[test]
#[allow(clippy::needless_borrow)]
fn test_basics() {
let m = HeaderMap::default();
assert!(m.is_empty());
let mut m = HeaderMap::with_capacity(10);
assert!(m.is_empty());
assert!(m.capacity() >= 10);
m.reserve(20);
assert!(m.capacity() >= 20);
m.insert(CONTENT_TYPE, HeaderValue::from_static("text"));
assert!(m.contains_key(CONTENT_TYPE));
assert!(m.contains_key("content-type"));
assert!(m.contains_key("content-type".to_string()));
assert!(m.contains_key(&("content-type".to_string())));
assert_eq!(
*m.get_mut("content-type").unwrap(),
HeaderValue::from_static("text")
);
assert_eq!(
*m.get_mut(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("text")
);
assert!(format!("{:?}", m).contains("HeaderMap"));
assert!(m.keys().any(|x| x == CONTENT_TYPE));
m.remove("content-type");
assert!(m.is_empty());
}
#[test]
fn test_append() {
let mut map = HeaderMap::new();
map.append(ACCEPT_ENCODING, HeaderValue::from_static("gzip"));
assert_eq!(
map.get_all(ACCEPT_ENCODING).collect::<Vec<_>>(),
vec![&HeaderValue::from_static("gzip"),]
);
map.append(ACCEPT_ENCODING, HeaderValue::from_static("br"));
map.append(ACCEPT_ENCODING, HeaderValue::from_static("deflate"));
assert_eq!(
map.get_all(ACCEPT_ENCODING).collect::<Vec<_>>(),
vec![
&HeaderValue::from_static("gzip"),
&HeaderValue::from_static("br"),
&HeaderValue::from_static("deflate"),
]
);
assert_eq!(
map.get(ACCEPT_ENCODING),
Some(&HeaderValue::from_static("gzip"))
);
assert_eq!(
map.get_mut(ACCEPT_ENCODING),
Some(&mut HeaderValue::from_static("gzip"))
);
map.remove(ACCEPT_ENCODING);
assert_eq!(map.get(ACCEPT_ENCODING), None);
}
#[test]
fn test_from_http() {
let mut map = http::HeaderMap::new();
map.append(ACCEPT_ENCODING, http::HeaderValue::from_static("gzip"));
let map2 = HeaderMap::from(map);
assert_eq!(
map2.get(ACCEPT_ENCODING),
Some(&HeaderValue::from_static("gzip"))
);
}
}