[−][src]Struct http::header::HeaderName
Represents an HTTP header field name
Header field names identify the header. Header sets may include multiple headers with the same name. The HTTP specification defines a number of standard headers, but HTTP messages may include non-standard header names as well as long as they adhere to the specification.
HeaderName
is used as the HeaderMap
key. Constants are available for
all standard header names in the header
module.
Representation
HeaderName
represents standard header names using an enum
, as such they
will not require an allocation for storage. All custom header names are
lower cased upon conversion to a HeaderName
value. This avoids the
overhead of dynamically doing lower case conversion during the hash code
computation and the comparison operation.
Implementations
impl HeaderName
[src]
pub fn from_bytes(src: &[u8]) -> Result<HeaderName, InvalidHeaderName>
[src]
Converts a slice of bytes to an HTTP header name.
This function normalizes the input.
pub fn from_lowercase(src: &[u8]) -> Result<HeaderName, InvalidHeaderName>
[src]
Converts a slice of bytes to an HTTP header name.
This function expects the input to only contain lowercase characters. This is useful when decoding HTTP/2.0 or HTTP/3.0 headers. Both require that all headers be represented in lower case.
Examples
// Parsing a lower case header let hdr = HeaderName::from_lowercase(b"content-length").unwrap(); assert_eq!(CONTENT_LENGTH, hdr); // Parsing a header that contains uppercase characters assert!(HeaderName::from_lowercase(b"Content-Length").is_err());
pub fn from_static(src: &'static str) -> HeaderName
[src]
Converts a static string to a HTTP header name.
This function panics when the static string is a invalid header.
This function requires the static string to only contain lowercase characters, numerals and symbols, as per the HTTP/2.0 specification and header names internal representation within this library.
Examples
// Parsing a standard header let hdr = HeaderName::from_static("content-length"); assert_eq!(CONTENT_LENGTH, hdr); // Parsing a custom header let CUSTOM_HEADER: &'static str = "custom-header"; let a = HeaderName::from_lowercase(b"custom-header").unwrap(); let b = HeaderName::from_static(CUSTOM_HEADER); assert_eq!(a, b);
// Parsing a header that contains invalid symbols(s): HeaderName::from_static("content{}{}length"); // This line panics! // Parsing a header that contains invalid uppercase characters. let a = HeaderName::from_static("foobar"); let b = HeaderName::from_static("FOOBAR"); // This line panics!
pub fn as_str(&self) -> &str
[src]
Returns a str
representation of the header.
The returned string will always be lower case.
Trait Implementations
impl AsHeaderName for HeaderName
[src]
impl<'a> AsHeaderName for &'a HeaderName
[src]
impl AsRef<[u8]> for HeaderName
[src]
impl AsRef<str> for HeaderName
[src]
impl Borrow<str> for HeaderName
[src]
impl Clone for HeaderName
[src]
fn clone(&self) -> HeaderName
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for HeaderName
[src]
impl Display for HeaderName
[src]
impl Eq for HeaderName
[src]
impl<'a> From<&'a HeaderName> for HeaderName
[src]
fn from(src: &'a HeaderName) -> HeaderName
[src]
impl From<HeaderName> for HeaderValue
[src]
fn from(h: HeaderName) -> HeaderValue
[src]
impl FromStr for HeaderName
[src]
type Err = InvalidHeaderName
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<HeaderName, InvalidHeaderName>
[src]
impl Hash for HeaderName
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl IntoHeaderName for HeaderName
[src]
impl<'a> IntoHeaderName for &'a HeaderName
[src]
impl<'a> PartialEq<&'a HeaderName> for HeaderName
[src]
fn eq(&self, other: &&'a HeaderName) -> bool
[src]
#[must_use]fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> PartialEq<&'a str> for HeaderName
[src]
fn eq(&self, other: &&'a str) -> bool
[src]
Performs a case-insensitive comparison of the string against the header name
#[must_use]fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<HeaderName> for HeaderName
[src]
fn eq(&self, other: &HeaderName) -> bool
[src]
fn ne(&self, other: &HeaderName) -> bool
[src]
impl<'a> PartialEq<HeaderName> for &'a HeaderName
[src]
impl PartialEq<HeaderName> for str
[src]
fn eq(&self, other: &HeaderName) -> bool
[src]
Performs a case-insensitive comparison of the string against the header name
Examples
use http::header::CONTENT_LENGTH; assert_eq!(CONTENT_LENGTH, "content-length"); assert_eq!(CONTENT_LENGTH, "Content-Length"); assert_ne!(CONTENT_LENGTH, "content length");
#[must_use]fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> PartialEq<HeaderName> for &'a str
[src]
fn eq(&self, other: &HeaderName) -> bool
[src]
Performs a case-insensitive comparison of the string against the header name
#[must_use]fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<str> for HeaderName
[src]
fn eq(&self, other: &str) -> bool
[src]
Performs a case-insensitive comparison of the string against the header name
Examples
use http::header::CONTENT_LENGTH; assert_eq!(CONTENT_LENGTH, "content-length"); assert_eq!(CONTENT_LENGTH, "Content-Length"); assert_ne!(CONTENT_LENGTH, "content length");
#[must_use]fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for HeaderName
[src]
impl StructuralPartialEq for HeaderName
[src]
impl<'a> TryFrom<&'a [u8]> for HeaderName
[src]
type Error = InvalidHeaderName
The type returned in the event of a conversion error.
fn try_from(s: &'a [u8]) -> Result<Self, Self::Error>
[src]
impl<'a> TryFrom<&'a String> for HeaderName
[src]
type Error = InvalidHeaderName
The type returned in the event of a conversion error.
fn try_from(s: &'a String) -> Result<Self, Self::Error>
[src]
impl<'a> TryFrom<&'a str> for HeaderName
[src]
Auto Trait Implementations
impl RefUnwindSafe for HeaderName
impl Send for HeaderName
impl Sync for HeaderName
impl Unpin for HeaderName
impl UnwindSafe for HeaderName
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,