Struct httpbis::HeaderName

pub struct HeaderName(_);

Representation of header name

Contained value is guaranteed to contain a valid header name.

Examples

assert_eq!("content-type", HeaderName::new("Content-Type").name());
assert_eq!(":method", HeaderName::pseudo(PseudoHeaderName::Method).name());

Implementations

impl HeaderName

pub fn pseudo(name: PseudoHeaderName) -> HeaderName

Construct a pseudo header name.

Example

assert_eq!(":method", HeaderName::pseudo(PseudoHeaderName::Method).name());

pub fn new(name: impl Into<Bytes>) -> HeaderName

Construct a header name from string

Example

Default construction

assert_eq!("content-type", HeaderName::new("Content-Type").name());
assert_eq!(":method", HeaderName::new(":method").name());

Panics

Panics on incorrect header name.

HeaderName::new("");

pub fn new_validate(name: Bytes) -> Result<HeaderName, (HeaderError, Bytes)>

Construct a header from given sequence of bytes

Returns error if header name is not valid, in particular if name is upper case.

Examples

assert!(HeaderName::new_validate(Bytes::from(":method")).is_ok());
assert!(HeaderName::new_validate(Bytes::from("Content-Type")).is_err());

pub fn name(&self) -> &str

Return a header name as a string.

pub fn is_pseudo(&self) -> bool

If header name is pseudo header name

pub fn pseudo_header_name(&self) -> Option<PseudoHeaderName>

Obtain pseudo header name from this header name

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 Display for HeaderName

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

Formats the value using the given formatter.

impl Eq for HeaderName

impl<'a> From<&'a [u8]> for HeaderName

fn from(s: &'a [u8]) -> Self

Performs the conversion.

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

fn from(s: &'a str) -> Self

Performs the conversion.

impl From<Bytes> for HeaderName

fn from(s: Bytes) -> Self

Performs the conversion.

impl From<PseudoHeaderName> for HeaderName

fn from(p: PseudoHeaderName) -> Self

Performs the conversion.

impl From<String> for HeaderName

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<u8>> for HeaderName

fn from(s: Vec<u8>) -> Self

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 Into<Bytes> for HeaderName

fn into(self) -> Bytes

Performs the conversion.

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 StructuralEq for HeaderName

impl StructuralPartialEq for HeaderName