Struct rama::http::HeaderName
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§
§impl HeaderName
impl HeaderName
pub 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.
pub 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());
pub const fn from_static(src: &'static str) -> HeaderName
pub const fn from_static(src: &'static str) -> HeaderName
Converts a static string to a HTTP header name.
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.
§Panics
This function panics when the static string is a invalid header.
Until Allow panicking in constants makes its way into stable, the panic message at compile-time is going to look cryptic, but should at least point at your header value:
error: any use of this value will cause an error
--> http/src/header/name.rs:1241:13
|
1241 | ([] as [u8; 0])[0]; // Invalid header name
| ^^^^^^^^^^^^^^^^^^
| |
| index out of bounds: the length is 0 but the index is 0
| inside `http::HeaderName::from_static` at http/src/header/name.rs:1241:13
| inside `INVALID_NAME` at src/main.rs:3:34
|
::: src/main.rs:3:1
|
3 | const INVALID_NAME: HeaderName = HeaderName::from_static("Capitalized");
| ------------------------------------------------------------------------
§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§
§impl AsRef<[u8]> for HeaderName
impl AsRef<[u8]> for HeaderName
§impl AsRef<str> for HeaderName
impl AsRef<str> for HeaderName
§impl Borrow<str> for HeaderName
impl Borrow<str> for HeaderName
§impl Clone for HeaderName
impl Clone for HeaderName
§fn clone(&self) -> HeaderName
fn clone(&self) -> HeaderName
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for HeaderName
impl Debug for HeaderName
§impl Display for HeaderName
impl Display for HeaderName
§impl<'a> From<&'a HeaderName> for HeaderName
impl<'a> From<&'a HeaderName> for HeaderName
§fn from(src: &'a HeaderName) -> HeaderName
fn from(src: &'a HeaderName) -> HeaderName
§impl From<HeaderName> for HeaderValue
impl From<HeaderName> for HeaderValue
§fn from(h: HeaderName) -> HeaderValue
fn from(h: HeaderName) -> HeaderValue
source§impl FromIterator<HeaderName> for AccessControlAllowHeaders
impl FromIterator<HeaderName> for AccessControlAllowHeaders
source§fn from_iter<I>(iter: I) -> AccessControlAllowHeaderswhere
I: IntoIterator<Item = HeaderName>,
fn from_iter<I>(iter: I) -> AccessControlAllowHeaderswhere
I: IntoIterator<Item = HeaderName>,
source§impl FromIterator<HeaderName> for AccessControlExposeHeaders
impl FromIterator<HeaderName> for AccessControlExposeHeaders
source§fn from_iter<I>(iter: I) -> AccessControlExposeHeaderswhere
I: IntoIterator<Item = HeaderName>,
fn from_iter<I>(iter: I) -> AccessControlExposeHeaderswhere
I: IntoIterator<Item = HeaderName>,
source§impl FromIterator<HeaderName> for AccessControlRequestHeaders
impl FromIterator<HeaderName> for AccessControlRequestHeaders
source§fn from_iter<I>(iter: I) -> AccessControlRequestHeaderswhere
I: IntoIterator<Item = HeaderName>,
fn from_iter<I>(iter: I) -> AccessControlRequestHeaderswhere
I: IntoIterator<Item = HeaderName>,
source§impl FromIterator<HeaderName> for Connection
impl FromIterator<HeaderName> for Connection
source§fn from_iter<I>(iter: I) -> Connectionwhere
I: IntoIterator<Item = HeaderName>,
fn from_iter<I>(iter: I) -> Connectionwhere
I: IntoIterator<Item = HeaderName>,
§impl FromStr for HeaderName
impl FromStr for HeaderName
§type Err = InvalidHeaderName
type Err = InvalidHeaderName
§fn from_str(s: &str) -> Result<HeaderName, InvalidHeaderName>
fn from_str(s: &str) -> Result<HeaderName, InvalidHeaderName>
s
to return a value of this type. Read more§impl Hash for HeaderName
impl Hash for HeaderName
§impl<'a> PartialEq<&'a HeaderName> for HeaderName
impl<'a> PartialEq<&'a HeaderName> for HeaderName
§fn eq(&self, other: &&'a HeaderName) -> bool
fn eq(&self, other: &&'a HeaderName) -> bool
self
and other
values to be equal, and is used
by ==
.§impl<'a> PartialEq<&'a str> for HeaderName
impl<'a> PartialEq<&'a str> for HeaderName
§impl<'a> PartialEq<HeaderName> for &'a HeaderName
impl<'a> PartialEq<HeaderName> for &'a HeaderName
§fn eq(&self, other: &HeaderName) -> bool
fn eq(&self, other: &HeaderName) -> bool
self
and other
values to be equal, and is used
by ==
.§impl<'a> PartialEq<HeaderName> for &'a str
impl<'a> PartialEq<HeaderName> for &'a str
§fn eq(&self, other: &HeaderName) -> bool
fn eq(&self, other: &HeaderName) -> bool
Performs a case-insensitive comparison of the string against the header name
§impl PartialEq<HeaderName> for str
impl PartialEq<HeaderName> for str
§fn 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");
§impl PartialEq<str> for HeaderName
impl PartialEq<str> for HeaderName
§impl PartialEq for HeaderName
impl PartialEq for HeaderName
§fn eq(&self, other: &HeaderName) -> bool
fn eq(&self, other: &HeaderName) -> bool
self
and other
values to be equal, and is used
by ==
.§impl<'a> TryFrom<&'a [u8]> for HeaderName
impl<'a> TryFrom<&'a [u8]> for HeaderName
§type Error = InvalidHeaderName
type Error = InvalidHeaderName
§fn try_from(
s: &'a [u8],
) -> Result<HeaderName, <HeaderName as TryFrom<&'a [u8]>>::Error>
fn try_from( s: &'a [u8], ) -> Result<HeaderName, <HeaderName as TryFrom<&'a [u8]>>::Error>
§impl<'a> TryFrom<&'a String> for HeaderName
impl<'a> TryFrom<&'a String> for HeaderName
§type Error = InvalidHeaderName
type Error = InvalidHeaderName
§fn try_from(
s: &'a String,
) -> Result<HeaderName, <HeaderName as TryFrom<&'a String>>::Error>
fn try_from( s: &'a String, ) -> Result<HeaderName, <HeaderName as TryFrom<&'a String>>::Error>
§impl<'a> TryFrom<&'a str> for HeaderName
impl<'a> TryFrom<&'a str> for HeaderName
§type Error = InvalidHeaderName
type Error = InvalidHeaderName
§fn try_from(
s: &'a str,
) -> Result<HeaderName, <HeaderName as TryFrom<&'a str>>::Error>
fn try_from( s: &'a str, ) -> Result<HeaderName, <HeaderName as TryFrom<&'a str>>::Error>
§impl TryFrom<String> for HeaderName
impl TryFrom<String> for HeaderName
§type Error = InvalidHeaderName
type Error = InvalidHeaderName
§fn try_from(
s: String,
) -> Result<HeaderName, <HeaderName as TryFrom<String>>::Error>
fn try_from( s: String, ) -> Result<HeaderName, <HeaderName as TryFrom<String>>::Error>
§impl TryFrom<Vec<u8>> for HeaderName
impl TryFrom<Vec<u8>> for HeaderName
§type Error = InvalidHeaderName
type Error = InvalidHeaderName
impl<'a> AsHeaderName for &'a HeaderName
impl AsHeaderName for HeaderName
impl Eq for HeaderName
impl<'a> IntoHeaderName for &'a HeaderName
impl IntoHeaderName for HeaderName
impl StructuralPartialEq for HeaderName
Auto Trait Implementations§
impl !Freeze for HeaderName
impl RefUnwindSafe for HeaderName
impl Send for HeaderName
impl Sync for HeaderName
impl Unpin for HeaderName
impl UnwindSafe for HeaderName
Blanket Implementations§
§impl<A, T> AsBits<T> for A
impl<A, T> AsBits<T> for A
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<S, P, B, E>(self, other: P) -> And<T, P>
fn and<S, P, B, E>(self, other: P) -> And<T, P>
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.source§impl<T> ToHex for T
impl<T> ToHex for T
source§fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
self
into the result. Lower case
letters are used (e.g. f9b4ca
)source§fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
self
into the result. Upper case
letters are used (e.g. F9B4CA
)§impl<T> ToStringFallible for Twhere
T: Display,
impl<T> ToStringFallible for Twhere
T: Display,
§fn try_to_string(&self) -> Result<String, TryReserveError>
fn try_to_string(&self) -> Result<String, TryReserveError>
ToString::to_string
, but without panic on OOM.