Struct surf::http::conditional::IfMatch

pub struct IfMatch { /* fields omitted */ }

Apply the HTTP method if the ETag matches.

Specifications

• RFC 7232, section 3.1: If-Match

Examples

use http_types::Response;
use http_types::conditional::{IfMatch, ETag};

let mut entries = IfMatch::new();
entries.push(ETag::new("0xcafebeef".to_string()));
entries.push(ETag::new("0xbeefcafe".to_string()));

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

let entries = IfMatch::from_headers(res)?.unwrap();
let mut entries = entries.iter();
assert_eq!(entries.next().unwrap(), &ETag::new("0xcafebeef".to_string()));
assert_eq!(entries.next().unwrap(), &ETag::new("0xbeefcafe".to_string()));

Implementations

impl IfMatch

pub fn new() -> IfMatch

Create a new instance of IfMatch.

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

Create a new instance from headers.

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

Sets the If-Match header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

pub fn push(&mut self, directive: impl Into<ETag>)

Push a directive into the list of entries.

pub fn wildcard(&self) -> bool

Returns true if a wildcard directive was set.

pub fn set_wildcard(&mut self, wildcard: bool)

Set the wildcard directive.

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 IfMatch

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

Formats the value using the given formatter.

impl IntoIterator for IfMatch

type Item = ETag

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = &'a mut ETag

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a> IntoIterator for &'a IfMatch

type Item = &'a ETag

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl ToHeaderValues for IfMatch

type Iter = IntoIter<HeaderValue>

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

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

Converts this object to an iterator of resolved HeaderValues.