Struct viaduct::HeaderName

pub struct HeaderName(pub(super) Cow<'static, str>);

Represents a header name that we know to be both valid and lowercase. Internally, this avoids allocating for headers that are constant strings, like the predefined ones in this crate, however even without that optimization, we would still likely have an equivalent of this for use as a case-insensitive string guaranteed to only have valid characters.

Implementations

impl HeaderName

pub fn new<S: Into<Cow<'static, str>>>(s: S) -> Result<Self, InvalidHeaderName>

Create a new header. In general you likely want to use HeaderName::from(s) instead for headers being specified locally (This will panic instead of returning a Result, since we have control over headers we specify locally, and want to know if we specify an illegal one).

pub fn as_str(&self) -> &str

Trait Implementations

impl AsRef<[u8]> for HeaderName

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<str> for HeaderName

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for HeaderName

fn clone(&self) -> HeaderName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderName

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

Formats the value using the given formatter.

impl Deref for HeaderName

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Display for HeaderName

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

Formats the value using the given formatter.

impl Eq for HeaderName

impl From<&'static str> for HeaderName

fn from(s: &'static str) -> HeaderName

Performs the conversion.

impl From<Cow<'static, str>> for HeaderName

fn from(s: Cow<'static, str>) -> HeaderName

Performs the conversion.

impl From<HeaderName> for String

fn from(h: HeaderName) -> Self

Performs the conversion.

impl From<HeaderName> for Cow<'static, str>

fn from(h: HeaderName) -> Self

Performs the conversion.

impl From<HeaderName> for Vec<u8>

fn from(h: HeaderName) -> Self

Performs the conversion.

impl From<String> for HeaderName

fn from(s: String) -> HeaderName

Performs the conversion.

impl Hash for HeaderName

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 HeaderName

fn cmp(&self, other: &HeaderName) -> 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<'a> PartialEq<&'a String> for HeaderName

fn eq(&self, other: &&'a String) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<&'a str> for HeaderName

fn eq(&self, other: &&'a str) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Cow<'a, str>> for HeaderName

fn eq(&self, other: &Cow<'a, str>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<HeaderName> for HeaderName

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

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

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

This method tests for !=.

impl<'a> PartialEq<HeaderName> for str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<HeaderName> for &'a str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<HeaderName> for String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<HeaderName> for &'a String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<HeaderName> for Cow<'a, str>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<String> for HeaderName

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<str> for HeaderName

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<HeaderName> for HeaderName

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for HeaderName

impl StructuralPartialEq for HeaderName