Struct Vary 

pub struct Vary(/* private fields */);

Available on crate feature http only.

Vary header, defined in RFC7231

The “Vary” header field in a response describes what parts of a request message, aside from the method, Host header field, and request target, might influence the origin server’s process for selecting and representing this response. The value consists of either a single asterisk (“*”) or a list of header field names (case-insensitive).

ABNF

Vary = "*" / 1#field-name

Example values

• accept-encoding, accept-language

Example

use rama_http_headers::Vary;

let vary = Vary::any();

Implementations

impl Vary

pub const fn any() -> Vary

Create a new Vary: * header.

pub fn preflight_request_headers() -> Vary

Creates a new Vary header with the request headers that may be involved in a CORS preflight request.

pub fn headers(values: NonEmptyVec<HeaderName>) -> Vary

Create a new Vary header for the given header (CS) names.

pub fn from_client_hints<'a>( hints: impl IntoIterator<Item = &'a ClientHint>, ) -> Option<Vary>

Create a Vary listing every request-header spelling the given ClientHints are read under — the same Sec-CH-* + legacy bare names an AcceptCh built from the same hints advertises — so caches keep a separate representation per client-hint value. Returns None only for an empty hint iterator.

pub const fn is_any(&self) -> bool

Check if this includes *.

pub fn iter_strs(&self) -> Option<impl Iterator<Item = &HeaderName>>

Iterate the header names of this Vary or None if it was an ‘any’ vary header.

Trait Implementations

impl Clone for Vary

fn clone(&self) -> Vary

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Vary

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

Formats the value using the given formatter.

impl HeaderDecode for Vary

fn decode<'i, I>(values: &mut I) -> Result<Vary, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for Vary

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl TypedHeader for Vary

fn name() -> &'static HeaderName

The name of this header.