<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `actix-http/src/header/utils.rs`."><title>utils.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_http" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Header parsing utilities.

</span><span class="kw">use </span>std::{fmt, str::FromStr};

<span class="kw">use </span><span class="kw">super</span>::HeaderValue;
<span class="kw">use crate</span>::{error::ParseError, header::HTTP_VALUE};

<span class="doccomment">/// Reads a comma-delimited raw header into a Vec.
</span><span class="attr">#[inline]
</span><span class="kw">pub fn </span>from_comma_delimited&lt;<span class="lifetime">'a</span>, I, T&gt;(all: I) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;T&gt;, ParseError&gt;
<span class="kw">where
    </span>I: Iterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">'a </span>HeaderValue&gt; + <span class="lifetime">'a</span>,
    T: FromStr,
{
    <span class="kw">let </span>size_guess = all.size_hint().<span class="number">1</span>.unwrap_or(<span class="number">2</span>);
    <span class="kw">let </span><span class="kw-2">mut </span>result = Vec::with_capacity(size_guess);

    <span class="kw">for </span>h <span class="kw">in </span>all {
        <span class="kw">let </span>s = h.to_str().map_err(|<span class="kw">_</span>| ParseError::Header)<span class="question-mark">?</span>;

        result.extend(
            s.split(<span class="string">','</span>)
                .filter_map(|x| <span class="kw">match </span>x.trim() {
                    <span class="string">"" </span>=&gt; <span class="prelude-val">None</span>,
                    y =&gt; <span class="prelude-val">Some</span>(y),
                })
                .filter_map(|x| x.trim().parse().ok()),
        )
    }

    <span class="prelude-val">Ok</span>(result)
}

<span class="doccomment">/// Reads a single string when parsing a header.
</span><span class="attr">#[inline]
</span><span class="kw">pub fn </span>from_one_raw_str&lt;T: FromStr&gt;(val: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>HeaderValue&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;T, ParseError&gt; {
    <span class="kw">if let </span><span class="prelude-val">Some</span>(line) = val {
        <span class="kw">let </span>line = line.to_str().map_err(|<span class="kw">_</span>| ParseError::Header)<span class="question-mark">?</span>;

        <span class="kw">if </span>!line.is_empty() {
            <span class="kw">return </span>T::from_str(line).or(<span class="prelude-val">Err</span>(ParseError::Header));
        }
    }

    <span class="prelude-val">Err</span>(ParseError::Header)
}

<span class="doccomment">/// Format an array into a comma-delimited string.
</span><span class="attr">#[inline]
</span><span class="kw">pub fn </span>fmt_comma_delimited&lt;T&gt;(f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;, parts: <span class="kw-2">&amp;</span>[T]) -&gt; fmt::Result
<span class="kw">where
    </span>T: fmt::Display,
{
    <span class="kw">let </span><span class="kw-2">mut </span>iter = parts.iter();

    <span class="kw">if let </span><span class="prelude-val">Some</span>(part) = iter.next() {
        fmt::Display::fmt(part, f)<span class="question-mark">?</span>;
    }

    <span class="kw">for </span>part <span class="kw">in </span>iter {
        f.write_str(<span class="string">", "</span>)<span class="question-mark">?</span>;
        fmt::Display::fmt(part, f)<span class="question-mark">?</span>;
    }

    <span class="prelude-val">Ok</span>(())
}

<span class="doccomment">/// Percent encode a sequence of bytes with a character set defined in [RFC 5987 §3.2].
///
/// [RFC 5987 §3.2]: https://datatracker.ietf.org/doc/html/rfc5987#section-3.2
</span><span class="attr">#[inline]
</span><span class="kw">pub fn </span>http_percent_encode(f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;, bytes: <span class="kw-2">&amp;</span>[u8]) -&gt; fmt::Result {
    <span class="kw">let </span>encoded = percent_encoding::percent_encode(bytes, HTTP_VALUE);
    fmt::Display::fmt(<span class="kw-2">&amp;</span>encoded, f)
}

<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
    <span class="kw">use super</span>::<span class="kw-2">*</span>;

    <span class="attr">#[test]
    </span><span class="kw">fn </span>comma_delimited_parsing() {
        <span class="kw">let </span>headers = [];
        <span class="kw">let </span>res: Vec&lt;usize&gt; = from_comma_delimited(headers.iter()).unwrap();
        <span class="macro">assert_eq!</span>(res, <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">0</span>]);

        <span class="kw">let </span>headers = [
            HeaderValue::from_static(<span class="string">"1, 2"</span>),
            HeaderValue::from_static(<span class="string">"3,4"</span>),
        ];
        <span class="kw">let </span>res: Vec&lt;usize&gt; = from_comma_delimited(headers.iter()).unwrap();
        <span class="macro">assert_eq!</span>(res, <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);

        <span class="kw">let </span>headers = [
            HeaderValue::from_static(<span class="string">""</span>),
            HeaderValue::from_static(<span class="string">","</span>),
            HeaderValue::from_static(<span class="string">"  "</span>),
            HeaderValue::from_static(<span class="string">"1    ,"</span>),
            HeaderValue::from_static(<span class="string">""</span>),
        ];
        <span class="kw">let </span>res: Vec&lt;usize&gt; = from_comma_delimited(headers.iter()).unwrap();
        <span class="macro">assert_eq!</span>(res, <span class="macro">vec!</span>[<span class="number">1</span>]);
    }
}
</code></pre></div></section></main></body></html>