Struct http::header::HeaderName
source · [−]pub struct HeaderName { /* private fields */ }
Expand description
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
sourceimpl HeaderName
impl HeaderName
sourcepub fn from_bytes(src: &[u8]) -> Result<HeaderName, InvalidHeaderName>
pub fn from_bytes(src: &[u8]) -> Result<HeaderName, InvalidHeaderName>
Converts a slice of bytes to an HTTP header name.
This function normalizes the input.
sourcepub fn from_lowercase(src: &[u8]) -> Result<HeaderName, InvalidHeaderName>
pub fn from_lowercase(src: &[u8]) -> Result<HeaderName, InvalidHeaderName>
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());
sourcepub fn from_static(src: &'static str) -> HeaderName
pub fn from_static(src: &'static str) -> HeaderName
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!
Trait Implementations
sourceimpl AsRef<[u8]> for HeaderName
impl AsRef<[u8]> for HeaderName
sourceimpl AsRef<str> for HeaderName
impl AsRef<str> for HeaderName
sourceimpl Borrow<str> for HeaderName
impl Borrow<str> for HeaderName
sourceimpl Clone for HeaderName
impl Clone for HeaderName
sourcefn clone(&self) -> HeaderName
fn clone(&self) -> HeaderName
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HeaderName
impl Debug for HeaderName
sourceimpl Display for HeaderName
impl Display for HeaderName
sourceimpl<'a> From<&'a HeaderName> for HeaderName
impl<'a> From<&'a HeaderName> for HeaderName
sourcefn from(src: &'a HeaderName) -> HeaderName
fn from(src: &'a HeaderName) -> HeaderName
Converts to this type from the input type.
sourceimpl From<HeaderName> for HeaderValue
impl From<HeaderName> for HeaderValue
sourcefn from(h: HeaderName) -> HeaderValue
fn from(h: HeaderName) -> HeaderValue
Converts to this type from the input type.
sourceimpl FromStr for HeaderName
impl FromStr for HeaderName
type Err = InvalidHeaderName
type Err = InvalidHeaderName
The associated error which can be returned from parsing.
sourcefn from_str(s: &str) -> Result<HeaderName, InvalidHeaderName>
fn from_str(s: &str) -> Result<HeaderName, InvalidHeaderName>
Parses a string s
to return a value of this type. Read more
sourceimpl Hash for HeaderName
impl Hash for HeaderName
sourceimpl<'a> PartialEq<&'a HeaderName> for HeaderName
impl<'a> PartialEq<&'a HeaderName> for HeaderName
sourceimpl<'a> PartialEq<&'a str> for HeaderName
impl<'a> PartialEq<&'a str> for HeaderName
sourceimpl PartialEq<HeaderName> for HeaderName
impl PartialEq<HeaderName> for HeaderName
sourcefn eq(&self, other: &HeaderName) -> bool
fn eq(&self, other: &HeaderName) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &HeaderName) -> bool
fn ne(&self, other: &HeaderName) -> bool
This method tests for !=
.
sourceimpl<'a> PartialEq<HeaderName> for &'a HeaderName
impl<'a> PartialEq<HeaderName> for &'a HeaderName
sourceimpl PartialEq<HeaderName> for str
impl PartialEq<HeaderName> for str
sourcefn eq(&self, other: &HeaderName) -> bool
fn eq(&self, other: &HeaderName) -> bool
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");
sourceimpl<'a> PartialEq<HeaderName> for &'a str
impl<'a> PartialEq<HeaderName> for &'a str
sourceimpl PartialEq<str> for HeaderName
impl PartialEq<str> for HeaderName
sourceimpl<'a> TryFrom<&'a [u8]> for HeaderName
impl<'a> TryFrom<&'a [u8]> for HeaderName
sourceimpl<'a> TryFrom<&'a String> for HeaderName
impl<'a> TryFrom<&'a String> for HeaderName
sourceimpl<'a> TryFrom<&'a str> for HeaderName
impl<'a> TryFrom<&'a str> for HeaderName
sourceimpl TryFrom<String> for HeaderName
impl TryFrom<String> for HeaderName
impl AsHeaderName for HeaderName
impl<'a> AsHeaderName for &'a HeaderName
impl Eq for HeaderName
impl IntoHeaderName for HeaderName
impl<'a> IntoHeaderName for &'a HeaderName
impl StructuralEq for HeaderName
impl StructuralPartialEq for HeaderName
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more