Struct CacheControl

pub struct CacheControl { /* private fields */ }

A Cache-Control header.

Examples

use http_types::Response;
use http_types::cache::{CacheControl, CacheDirective};
let mut entries = CacheControl::new();
entries.push(CacheDirective::Immutable);
entries.push(CacheDirective::NoStore);

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

let entries = CacheControl::from_headers(res)?.unwrap();
let mut entries = entries.iter();
assert_eq!(entries.next().unwrap(), &CacheDirective::Immutable);
assert_eq!(entries.next().unwrap(), &CacheDirective::NoStore);

Implementations

impl CacheControl

pub fn new() -> CacheControl

Create a new instance of CacheControl.

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

Create a new instance from headers.

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

Sets the Server-Timing header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

pub fn push(&mut self, directive: CacheDirective)

Push a directive into the list of entries.

pub fn iter(&self) -> Iter<'_>

An iterator visiting all server entries.

pub fn iter_mut(&mut self) -> IterMut<'_>

An iterator visiting all server entries.

Trait Implementations

impl Debug for CacheControl

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a CacheControl

type Item = &'a CacheDirective

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a CacheControl as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut CacheControl

type Item = &'a mut CacheDirective

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut CacheControl as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for CacheControl

type Item = CacheDirective

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <CacheControl as IntoIterator>::IntoIter

Creates an iterator from a value.

impl ToHeaderValues for CacheControl

type Iter = IntoIter<HeaderValue>

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

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

Converts this object to an iterator of resolved HeaderValues.