Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / httpdate / lib.rs.html
blob: c67a3ddf57828fb724c2987e5f426ecf0b6a9da7 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/httpdate-1.0.2/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../httpdate/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../httpdate/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
</pre><pre class="rust"><code><span class="doccomment">//! Date and time utils for HTTP.
//!
//! Multiple HTTP header fields store timestamps.
//! For example a response created on May 15, 2015 may contain the header
//! `Date: Fri, 15 May 2015 15:34:21 GMT`. Since the timestamp does not
//! contain any timezone or leap second information it is equvivalent to
//! writing 1431696861 Unix time. Rust’s `SystemTime` is used to store
//! these timestamps.
//!
//! This crate provides two public functions:
//!
//! * `parse_http_date` to parse a HTTP datetime string to a system time
//! * `fmt_http_date` to format a system time to a IMF-fixdate
//!
//! In addition it exposes the `HttpDate` type that can be used to parse
//! and format timestamps. Convert a sytem time to `HttpDate` and vice versa.
//! The `HttpType` (8 bytes) is smaller than `SystemTime` (16 bytes) and
//! using the display impl avoids a temporary allocation.
</span><span class="attribute">#![forbid(unsafe_code)]
</span><span class="kw">use </span>std::error;
<span class="kw">use </span>std::fmt::{<span class="self">self</span>, Display, Formatter};
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::time::SystemTime;
<span class="kw">pub use </span>date::HttpDate;
<span class="kw">mod </span>date;
<span class="doccomment">/// An opaque error type for all parsing errors.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Error(());
<span class="kw">impl </span>error::Error <span class="kw">for </span>Error {}
<span class="kw">impl </span>Display <span class="kw">for </span>Error {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>Formatter) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
f.write_str(<span class="string">&quot;string contains no or an invalid date&quot;</span>)
}
}
<span class="kw">impl </span>From&lt;Error&gt; <span class="kw">for </span>io::Error {
<span class="kw">fn </span>from(e: Error) -&gt; io::Error {
io::Error::new(io::ErrorKind::Other, e)
}
}
<span class="doccomment">/// Parse a date from an HTTP header field.
///
/// Supports the preferred IMF-fixdate and the legacy RFC 805 and
/// ascdate formats. Two digit years are mapped to dates between
/// 1970 and 2069.
</span><span class="kw">pub fn </span>parse_http_date(s: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;SystemTime, Error&gt; {
s.parse::&lt;HttpDate&gt;().map(|d| d.into())
}
<span class="doccomment">/// Format a date to be used in a HTTP header field.
///
/// Dates are formatted as IMF-fixdate: `Fri, 15 May 2015 15:34:21 GMT`.
</span><span class="kw">pub fn </span>fmt_http_date(d: SystemTime) -&gt; String {
<span class="macro">format!</span>(<span class="string">&quot;{}&quot;</span>, HttpDate::from(d))
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::str;
<span class="kw">use </span>std::time::{Duration, UNIX_EPOCH};
<span class="kw">use super</span>::{fmt_http_date, parse_http_date, HttpDate};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_rfc_example() {
<span class="kw">let </span>d = UNIX_EPOCH + Duration::from_secs(<span class="number">784111777</span>);
<span class="macro">assert_eq!</span>(
d,
parse_http_date(<span class="string">&quot;Sun, 06 Nov 1994 08:49:37 GMT&quot;</span>).expect(<span class="string">&quot;#1&quot;</span>)
);
<span class="macro">assert_eq!</span>(
d,
parse_http_date(<span class="string">&quot;Sunday, 06-Nov-94 08:49:37 GMT&quot;</span>).expect(<span class="string">&quot;#2&quot;</span>)
);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Sun Nov 6 08:49:37 1994&quot;</span>).expect(<span class="string">&quot;#3&quot;</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test2() {
<span class="kw">let </span>d = UNIX_EPOCH + Duration::from_secs(<span class="number">1475419451</span>);
<span class="macro">assert_eq!</span>(
d,
parse_http_date(<span class="string">&quot;Sun, 02 Oct 2016 14:44:11 GMT&quot;</span>).expect(<span class="string">&quot;#1&quot;</span>)
);
<span class="macro">assert!</span>(parse_http_date(<span class="string">&quot;Sun Nov 10 08:00:00 1000&quot;</span>).is_err());
<span class="macro">assert!</span>(parse_http_date(<span class="string">&quot;Sun Nov 10 08*00:00 2000&quot;</span>).is_err());
<span class="macro">assert!</span>(parse_http_date(<span class="string">&quot;Sunday, 06-Nov-94 08+49:37 GMT&quot;</span>).is_err());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test3() {
<span class="kw">let </span><span class="kw-2">mut </span>d = UNIX_EPOCH;
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Thu, 01 Jan 1970 00:00:00 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">3600</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Thu, 01 Jan 1970 01:00:00 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">86400</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Fri, 02 Jan 1970 01:00:00 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">2592000</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Sun, 01 Feb 1970 01:00:00 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">2592000</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Tue, 03 Mar 1970 01:00:00 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">31536005</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Wed, 03 Mar 1971 01:00:05 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">15552000</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Mon, 30 Aug 1971 01:00:05 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">6048000</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Mon, 08 Nov 1971 01:00:05 GMT&quot;</span>).unwrap());
d += Duration::from_secs(<span class="number">864000000</span>);
<span class="macro">assert_eq!</span>(d, parse_http_date(<span class="string">&quot;Fri, 26 Mar 1999 01:00:05 GMT&quot;</span>).unwrap());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_fmt() {
<span class="kw">let </span>d = UNIX_EPOCH;
<span class="macro">assert_eq!</span>(fmt_http_date(d), <span class="string">&quot;Thu, 01 Jan 1970 00:00:00 GMT&quot;</span>);
<span class="kw">let </span>d = UNIX_EPOCH + Duration::from_secs(<span class="number">1475419451</span>);
<span class="macro">assert_eq!</span>(fmt_http_date(d), <span class="string">&quot;Sun, 02 Oct 2016 14:44:11 GMT&quot;</span>);
}
<span class="attribute">#[allow(dead_code)]
</span><span class="kw">fn </span>testcase(data: <span class="kw-2">&amp;</span>[u8]) {
<span class="kw">if let </span><span class="prelude-val">Ok</span>(s) = str::from_utf8(data) {
<span class="macro">println!</span>(<span class="string">&quot;{:?}&quot;</span>, s);
<span class="kw">if let </span><span class="prelude-val">Ok</span>(d) = parse_http_date(s) {
<span class="kw">let </span>o = fmt_http_date(d);
<span class="macro">assert!</span>(!o.is_empty());
}
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>size_of() {
<span class="macro">assert_eq!</span>(::std::mem::size_of::&lt;HttpDate&gt;(), <span class="number">8</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_date_comparison() {
<span class="kw">let </span>a = UNIX_EPOCH + Duration::from_secs(<span class="number">784111777</span>);
<span class="kw">let </span>b = a + Duration::from_secs(<span class="number">30</span>);
<span class="macro">assert!</span>(a &lt; b);
<span class="kw">let </span>a_date: HttpDate = a.into();
<span class="kw">let </span>b_date: HttpDate = b.into();
<span class="macro">assert!</span>(a_date &lt; b_date);
<span class="macro">assert_eq!</span>(a_date.cmp(<span class="kw-2">&amp;</span>b_date), ::std::cmp::Ordering::Less)
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_parse_bad_date() {
<span class="comment">// 1994-11-07 is actually a Monday
</span><span class="kw">let </span>parsed = <span class="string">&quot;Sun, 07 Nov 1994 08:48:37 GMT&quot;</span>.parse::&lt;HttpDate&gt;();
<span class="macro">assert!</span>(parsed.is_err())
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="httpdate" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>