ohkami 0.24.9

A performant, declarative, and runtime-flexible web framework for Rust
Documentation 
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

use ohkami_lib::{Slice, percent_decode_utf8};
use std::borrow::Cow;

#[derive(PartialEq)]
pub struct QueryParams(
    /// raw bytes of query params with leading '?' cut
    ///
    /// ex) name=ohkami&type=framework
    Slice,
);

impl QueryParams {
    #[cfg(feature = "__rt__")]
    #[inline(always)]
    pub(crate) const fn new(bytes: &[u8]) -> Self {
        Self(Slice::from_bytes(bytes))
    }

    #[inline(always)]
    pub fn parse<'q, T: serde::Deserialize<'q>>(&'q self) -> Result<T, impl serde::de::Error> {
        ohkami_lib::serde_urlencoded::from_bytes(unsafe { self.0.as_bytes() })
    }

    #[inline(always)]
    ///Returns whether query params has anything to it, even if it is invalid
    pub fn is_empty(&self) -> bool {
        unsafe { self.0.as_bytes().is_empty() }
    }

    ///Returns iterator over the query params, if any was set
    pub fn non_empty_iter(&self) -> Option<impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>> {
        let bytes = unsafe { self.0.as_bytes() };
        if bytes.is_empty() {
            None
        } else {
            Some(bytes.split(|b| b == &b'&').filter_map(|kv| {
                match kv.iter().position(|b| b == &b'=') {
                    None => {
                        #[cfg(debug_assertions)]
                        {
                            if kv.is_empty() {
                                crate::WARNING!("skipping an invalid query param: trailing `&`");
                            } else {
                                crate::WARNING!("skipping an invalid query param: missing `=`");
                            }
                        }
                        None
                    }
                    Some(0) => {
                        #[cfg(debug_assertions)]
                        {
                            crate::WARNING!("skipping an invalid query param: empty key");
                        }
                        None
                    }
                    Some(n) => Some((
                        percent_decode_utf8(unsafe { kv.get_unchecked(..n) }).ok()?,
                        percent_decode_utf8(unsafe { kv.get_unchecked(n + 1..) }).ok()?,
                    )),
                }
            }))
        }
    }

    #[inline(always)]
    pub fn iter(&self) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)> {
        self.non_empty_iter().into_iter().flatten()
    }
}

const _: () = {
    impl std::fmt::Debug for QueryParams {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            f.debug_map().entries(self.iter()).finish()
        }
    }
};

#[cfg(feature = "__rt_native__")]
#[cfg(test)]
const _: () = {
    impl<const N: usize> From<[(&'static str, &'static str); N]> for QueryParams {
        fn from(kvs: [(&'static str, &'static str); N]) -> Self {
            use ohkami_lib::percent_encode;

            let raw = kvs
                .into_iter()
                .map(|(k, v)| format!("{}={}", percent_encode(k), percent_encode(v),))
                .collect::<Vec<_>>()
                .join("&");

            QueryParams::new(Box::leak(raw.into_boxed_str()).as_bytes())
        }
    }
};

#[cfg(not(feature = "rt_worker"))]
#[cfg(test)]
#[test]
fn query_iter() {
    let case = QueryParams(Slice::from_bytes(b"abc=def&xyz=123"));
    assert_eq!(
        case.iter().collect::<Vec<_>>(),
        [("abc".into(), "def".into()), ("xyz".into(), "123".into()),]
    );

    let case = QueryParams(Slice::from_bytes(
        b"abc=def&xyz=%E4%B8%80%E4%BA%8C%E4%B8%89",
    ));
    assert_eq!(
        case.iter().collect::<Vec<_>>(),
        [
            ("abc".into(), "def".into()),
            ("xyz".into(), "一二三".into()),
        ]
    );

    let case = QueryParams(Slice::from_bytes(b"abc=def&xyz="));
    assert_eq!(
        case.iter().collect::<Vec<_>>(),
        [("abc".into(), "def".into()), ("xyz".into(), "".into()),]
    );

    let case = QueryParams(Slice::from_bytes(b"abc=def&xyz"));
    // skipping an invalid query param: missing `=`
    assert_eq!(
        case.iter().collect::<Vec<_>>(),
        [("abc".into(), "def".into()),]
    );

    let case = QueryParams(Slice::from_bytes(b"abc=def&"));
    // skipping an invalid query param: trailing `&`
    assert_eq!(
        case.iter().collect::<Vec<_>>(),
        [("abc".into(), "def".into()),]
    );

    let case = QueryParams(Slice::from_bytes(b"abc=def"));
    assert_eq!(
        case.iter().collect::<Vec<_>>(),
        [("abc".into(), "def".into()),]
    );

    let case = QueryParams(Slice::from_bytes(b""));
    assert_eq!(case.iter().collect::<Vec<_>>(), []);
}