Struct surf::http::cache::Expires

pub struct Expires { /* fields omitted */ }

HTTP Expires header

Specifications

• RFC 7234, section 5.3: Expires

Examples

use http_types::Response;
use http_types::cache::Expires;
use std::time::{SystemTime, Duration};

let time = SystemTime::now() + Duration::from_secs(5 * 60);
let expires = Expires::new_at(time);

let mut res = Response::new(200);
expires.apply(&mut res);

let expires = Expires::from_headers(res)?.unwrap();

// HTTP dates only have second-precision.
let elapsed = time.duration_since(expires.expiration())?;
assert_eq!(elapsed.as_secs(), 0);

Implementations

impl Expires

pub fn new(dur: Duration) -> Expires

Create a new instance of Expires.

pub fn new_at(instant: SystemTime) -> Expires

Create a new instance of Expires from secs.

pub fn expiration(&self) -> SystemTime

Get the expiration time.

pub fn from_headers(
    headers: impl AsRef<Headers>
) -> Result<Option<Expires>, Error>

Create an instance of Expires from a Headers instance.

pub fn apply(&self, headers: impl AsMut<Headers>)

Insert a HeaderName + HeaderValue pair into a Headers instance.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

Trait Implementations

impl Debug for Expires

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Expires

impl Ord for Expires

pub fn cmp(&self, other: &Expires) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Expires> for Expires

pub fn eq(&self, other: &Expires) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Expires) -> bool

This method tests for !=.

impl PartialOrd<Expires> for Expires

pub fn partial_cmp(&self, other: &Expires) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Expires) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Expires) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Expires) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Expires) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Expires

impl StructuralPartialEq for Expires

impl ToHeaderValues for Expires

type Iter = IntoIter<HeaderValue>

Returned iterator over header values which this type may correspond to.

pub fn to_header_values(
    &self
) -> Result<<Expires as ToHeaderValues>::Iter, Error>

Converts this object to an iterator of resolved HeaderValues.