Struct http::header::HeaderName[][src]

pub struct HeaderName { /* fields omitted */ }

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.

Methods

impl HeaderName
[src]

Converts a slice of bytes to an HTTP header name.

This function normalizes the input.

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 headers. The HTTP/2.0 specification requires 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());

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!

Returns a str representation of the header.

The returned string will always be lower case.

Trait Implementations

impl IntoHeaderName for HeaderName
[src]

impl<'a> IntoHeaderName for &'a HeaderName
[src]

impl AsHeaderName for HeaderName
[src]

impl<'a> AsHeaderName for &'a HeaderName
[src]

impl Clone for HeaderName
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Eq for HeaderName
[src]

impl PartialEq for HeaderName
[src]

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

This method tests for !=.

impl Hash for HeaderName
[src]

Feeds this value into the given [Hasher]. Read more

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

impl FromStr for HeaderName
[src]

The associated error which can be returned from parsing.

Parses a string s to return a value of this type. Read more

impl AsRef<str> for HeaderName
[src]

Performs the conversion.

impl AsRef<[u8]> for HeaderName
[src]

Performs the conversion.

impl Borrow<str> for HeaderName
[src]

Immutably borrows from an owned value. Read more

impl Debug for HeaderName
[src]

Formats the value using the given formatter. Read more

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

Performs the conversion.

impl From<HeaderName> for Bytes
[src]

Performs the conversion.

impl<'a> HttpTryFrom<&'a str> for HeaderName
[src]

Associated error with the conversion this implementation represents.

impl<'a> HttpTryFrom<&'a [u8]> for HeaderName
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<Bytes> for HeaderName
[src]

Associated error with the conversion this implementation represents.

impl<'a> PartialEq<&'a HeaderName> for HeaderName
[src]

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

This method tests for !=.

impl<'a> PartialEq<HeaderName> for &'a HeaderName
[src]

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

This method tests for !=.

impl PartialEq<str> for HeaderName
[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");

This method tests for !=.

impl PartialEq<HeaderName> for str
[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");

This method tests for !=.

impl<'a> PartialEq<&'a str> for HeaderName
[src]

Performs a case-insensitive comparison of the string against the header name

This method tests for !=.

impl<'a> PartialEq<HeaderName> for &'a str
[src]

Performs a case-insensitive comparison of the string against the header name

This method tests for !=.

impl From<HeaderName> for HeaderValue
[src]

Performs the conversion.

impl HttpTryFrom<HeaderName> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<HeaderName> for HeaderName
[src]

Associated error with the conversion this implementation represents.

Auto Trait Implementations

impl Send for HeaderName

impl Sync for HeaderName