Struct viaduct::headers::Header

pub struct Header {
    pub(crate) name: HeaderName,
    pub(crate) value: String,
}

A single header. Headers have a name (case insensitive) and a value. The character set for header and values are both restrictive.

• Names must only contain a-zA-Z0-9 and and ('!' | '#' | '$' | '%' | '&' | ''' | '*' | '+' | '-' | '.' | '^' | '_' | '`' | '|' | '~') characters (the field-name token production defined at https://tools.ietf.org/html/rfc7230#section-3.2). For request headers, we expect these to all be specified statically, and so we panic if you provide an invalid one. (For response headers, we ignore headers with invalid names, but emit a warning).

  Header names are case insensitive, and we have several pre-defined ones in the [header_names] module.

• Values may only contain printable ascii characters, and may not contain \r or \n. Strictly speaking, HTTP is more flexible for header values, however we don't need to support binary header values, and so we do not.

Note that typically you should not interact with this directly, and instead use the methods on [Request] or [Headers] to manipulate these.

Fields

name: HeaderName

value: String

Implementations

impl Header

pub fn new<Name, Value>(name: Name, value: Value) -> Result<Self, Error> where
    Name: Into<HeaderName>,
    Value: AsRef<str> + Into<String>, 

pub fn new_unchecked<Value>(name: HeaderName, value: Value) -> Self where
    Value: AsRef<str> + Into<String>, 

pub fn name(&self) -> &HeaderName

pub fn value(&self) -> &str

fn set_value<V: AsRef<str>>(&mut self, s: V) -> Result<(), Error>

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Display for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl FromIterator<Header> for Headers

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Header>, 

Creates a value from an iterator.

impl Hash for Header

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Header

fn cmp(&self, other: &Header) -> 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<Header> for Header

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

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

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

This method tests for !=.

impl PartialOrd<Header> for Header

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Header

impl StructuralPartialEq for Header