Enum Vary 

pub enum Vary {
    Wildcard,
    Headers(Vec<String>),
}

The Vary response header (RFC 7231 §7.1.4).

Encodes the set of request header field names that were used to select the representation. The special value * means any request header may affect the response.

Variants

Wildcard

Vary: * — response is uncacheable by shared caches.

Headers(Vec<String>)

Vary: <header-name>, ... — a specific list of header names.

Implementations

impl Vary

pub fn new() -> Self

Create an empty Vary with no header names.

pub fn wildcard() -> Self

Create a wildcard Vary: *.

pub fn is_wildcard(&self) -> bool

Returns true if this is the wildcard variant.

pub fn headers(&self) -> Option<&[String]>

Returns the list of header names, or None if this is a wildcard.

pub fn add(&mut self, name: impl Into<String>)

Add a header name to the Vary list.

If self is Vary::Wildcard this is a no-op. Duplicate names (case-insensitive) are not added a second time.

use api_bones::vary::Vary;

let mut v = Vary::new();
v.add("Accept");
v.add("accept"); // duplicate — ignored
assert_eq!(v.to_string(), "Accept");

pub fn remove(&mut self, name: &str) -> bool

Remove a header name from the Vary list (case-insensitive).

Returns true if the name was present and removed. Always returns false for the wildcard variant.

use api_bones::vary::Vary;

let mut v = Vary::new();
v.add("Accept");
assert!(v.remove("ACCEPT"));
assert_eq!(v.to_string(), "");

pub fn contains(&self, name: &str) -> bool

Returns true if the named header is in the Vary list (case-insensitive).

Always returns false for the wildcard variant.

use api_bones::vary::Vary;

let mut v = Vary::new();
v.add("Accept-Encoding");
assert!(v.contains("accept-encoding"));
assert!(!v.contains("accept"));

pub fn len(&self) -> Option<usize>

Returns the number of header names in the list, or None for wildcard.

pub fn is_empty(&self) -> bool

Returns true when the list is empty (not a wildcard, and no names).

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

Formats the value using the given formatter.

impl Default for Vary

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Vary

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

Formats the value using the given formatter.

impl FromStr for Vary

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a Vary header value.

use api_bones::vary::Vary;

let v: Vary = "*".parse().unwrap();
assert!(v.is_wildcard());

let v: Vary = "Accept, Accept-Encoding".parse().unwrap();
assert!(v.contains("Accept-Encoding"));

type Err = ParseVaryError

The associated error which can be returned from parsing.

impl PartialEq for Vary

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Vary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Vary

impl StructuralPartialEq for Vary