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

// Copyright 2019 Palantir Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Query parameters.
use std::collections::hash_map::{self, Entry, HashMap};
use std::ops::Index;

#[doc(inline)]
pub use crate::query_params::values::Values;

pub mod values;

/// A data structure storing the query parameters of a request.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct QueryParams(HashMap<String, Values>);

impl QueryParams {
    /// Creates a new, empty `QueryParams`.
    #[inline]
    pub fn new() -> QueryParams {
        QueryParams::default()
    }

    /// Inserts a parameter.
    ///
    /// If the key already exists, the new value will be added to the existing values.
    pub fn insert<T, U>(&mut self, key: T, value: U)
    where
        T: Into<String>,
        U: Into<String>,
    {
        self.0
            .entry(key.into())
            .or_insert_with(Values::new)
            .push(value)
    }

    /// Inserts multiple parameters.
    ///
    /// If the key already exists, the new values will be added to the existing values.
    pub fn insert_all<T, U, I>(&mut self, key: T, values: I)
    where
        T: Into<String>,
        U: Into<String>,
        I: IntoIterator<Item = U>,
    {
        match self.0.entry(key.into()) {
            Entry::Occupied(mut e) => e.get_mut().extend(values),
            Entry::Vacant(e) => {
                let mut new = Values::new();
                new.extend(values);
                if !new.is_empty() {
                    e.insert(new);
                }
            }
        }
    }

    /// Returns an iterator over the parameters.
    #[inline]
    pub fn iter(&self) -> Iter<'_> {
        Iter(self.0.iter())
    }
}

impl<'a> IntoIterator for &'a QueryParams {
    type Item = (&'a str, &'a Values);
    type IntoIter = Iter<'a>;

    #[inline]
    fn into_iter(self) -> Iter<'a> {
        self.iter()
    }
}

impl<'a> Index<&'a str> for QueryParams {
    type Output = Values;

    #[inline]
    fn index(&self, key: &'a str) -> &Values {
        static EMPTY: Values = Values::new();
        self.0.get(key).unwrap_or_else(|| &EMPTY)
    }
}

/// An iterator over query parameters.
pub struct Iter<'a>(hash_map::Iter<'a, String, Values>);

impl<'a> Iterator for Iter<'a> {
    type Item = (&'a str, &'a Values);

    #[inline]
    fn next(&mut self) -> Option<(&'a str, &'a Values)> {
        self.0.next().map(|v| (&**v.0, v.1))
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.0.size_hint()
    }
}

impl<'a> ExactSizeIterator for Iter<'a> {
    #[inline]
    fn len(&self) -> usize {
        self.0.len()
    }
}