Skip to content

Commit

Permalink
Add conditional::LastModified
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshuawuyts authored and Fishrock123 committed Sep 14, 2020
1 parent 86df101 commit 2aba1bd
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/conditional/if_modified_since.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ impl IfModifiedSince {
Self { instant }
}

/// Get the expiration time.
/// Returns the last modification time listed.
pub fn modified(&self) -> SystemTime {
self.instant
}
Expand Down
2 changes: 1 addition & 1 deletion src/conditional/if_unmodified_since.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ impl IfUnmodifiedSince {
Self { instant }
}

/// Get the expiration time.
/// Returns the last modification time listed.
pub fn modified(&self) -> SystemTime {
self.instant
}
Expand Down
125 changes: 125 additions & 0 deletions src/conditional/last_modified.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
use crate::headers::{HeaderName, HeaderValue, Headers, ToHeaderValues, LAST_MODIFIED};
use crate::utils::{fmt_http_date, parse_http_date};

use std::fmt::Debug;
use std::option;
use std::time::SystemTime;

/// HTTP `LastModified` header
///
/// # Specifications
///
/// - [RFC 7232, section 2.2: Last-Modified](https://tools.ietf.org/html/rfc7232#section-2.2)
///
/// # Examples
///
/// ```
/// # fn main() -> http_types::Result<()> {
/// #
/// use http_types::Response;
/// use http_types::conditional::LastModified;
/// use std::time::{SystemTime, Duration};
///
/// let time = SystemTime::now() + Duration::from_secs(5 * 60);
/// let last_modified = LastModified::new(time);
///
/// let mut res = Response::new(200);
/// last_modified.apply(&mut res);
///
/// let last_modified = LastModified::from_headers(res)?.unwrap();
///
/// // HTTP dates only have second-precision.
/// let elapsed = time.duration_since(last_modified.modified())?;
/// assert_eq!(elapsed.as_secs(), 0);
/// #
/// # Ok(()) }
/// ```
#[derive(Debug, Ord, PartialOrd, Eq, PartialEq)]
pub struct LastModified {
instant: SystemTime,
}

impl LastModified {
/// Create a new instance of `LastModified`.
pub fn new(instant: SystemTime) -> Self {
Self { instant }
}

/// Returns the last modification time listed.
pub fn modified(&self) -> SystemTime {
self.instant
}

/// Create an instance of `LastModified` from a `Headers` instance.
pub fn from_headers(headers: impl AsRef<Headers>) -> crate::Result<Option<Self>> {
let headers = match headers.as_ref().get(LAST_MODIFIED) {
Some(headers) => headers,
None => return Ok(None),
};

// If we successfully parsed the header then there's always at least one
// entry. We want the last entry.
let header = headers.iter().last().unwrap();

let instant = parse_http_date(header.as_str())?;
Ok(Some(Self { instant }))
}

/// Insert a `HeaderName` + `HeaderValue` pair into a `Headers` instance.
pub fn apply(&self, mut headers: impl AsMut<Headers>) {
headers.as_mut().insert(LAST_MODIFIED, self.value());
}

/// Get the `HeaderName`.
pub fn name(&self) -> HeaderName {
LAST_MODIFIED
}

/// Get the `HeaderValue`.
pub fn value(&self) -> HeaderValue {
let output = fmt_http_date(self.instant);

// SAFETY: the internal string is validated to be ASCII.
unsafe { HeaderValue::from_bytes_unchecked(output.into()) }
}
}

impl ToHeaderValues for LastModified {
type Iter = option::IntoIter<HeaderValue>;
fn to_header_values(&self) -> crate::Result<Self::Iter> {
// A HeaderValue will always convert into itself.
Ok(self.value().to_header_values().unwrap())
}
}

#[cfg(test)]
mod test {
use super::*;
use crate::headers::Headers;
use std::time::Duration;

#[test]
fn smoke() -> crate::Result<()> {
let time = SystemTime::now() + Duration::from_secs(5 * 60);
let last_modified = LastModified::new(time);

let mut headers = Headers::new();
last_modified.apply(&mut headers);

let last_modified = LastModified::from_headers(headers)?.unwrap();

// HTTP dates only have second-precision
let elapsed = time.duration_since(last_modified.modified())?;
assert_eq!(elapsed.as_secs(), 0);
Ok(())
}

#[test]
fn bad_request_on_parse_error() -> crate::Result<()> {
let mut headers = Headers::new();
headers.insert(LAST_MODIFIED, "<nori ate the tag. yum.>");
let err = LastModified::from_headers(headers).unwrap_err();
assert_eq!(err.status(), 400);
Ok(())
}
}
2 changes: 2 additions & 0 deletions src/conditional/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
mod etag;
mod if_modified_since;
mod if_unmodified_since;
mod last_modified;

pub use etag::ETag;
pub use if_modified_since::IfModifiedSince;
pub use if_unmodified_since::IfUnmodifiedSince;
pub use last_modified::LastModified;

0 comments on commit 2aba1bd

Please sign in to comment.