Struct hyper::header::HeaderValue [−][src]
Represents an HTTP header field value.
In practice, HTTP header field values are usually valid ASCII. However, the HTTP spec allows for a header value to contain opaque bytes as well. In this case, the header field value is not able to be represented as a string.
To handle this, the HeaderValue
is useable as a type and can be compared
with strings and implements Debug
. A to_str
fn is provided that returns
an Err
if the header value contains non visible ascii characters.
Implementations
impl HeaderValue
[src]
pub fn from_static(src: &'static str) -> HeaderValue
[src]
Convert a static string to a HeaderValue
.
This function will not perform any copying, however the string is checked to ensure that no invalid characters are present. Only visible ASCII characters (32-127) are permitted.
Panics
This function panics if the argument contains invalid header value characters.
Examples
let val = HeaderValue::from_static("hello"); assert_eq!(val, "hello");
pub fn from_str(src: &str) -> Result<HeaderValue, InvalidHeaderValue>
[src]
Attempt to convert a string to a HeaderValue
.
If the argument contains invalid header value characters, an error is
returned. Only visible ASCII characters (32-127) are permitted. Use
from_bytes
to create a HeaderValue
that includes opaque octets
(128-255).
This function is intended to be replaced in the future by a TryFrom
implementation once the trait is stabilized in std.
Examples
let val = HeaderValue::from_str("hello").unwrap(); assert_eq!(val, "hello");
An invalid value
let val = HeaderValue::from_str("\n"); assert!(val.is_err());
pub fn from_name(name: HeaderName) -> HeaderValue
[src]
Converts a HeaderName into a HeaderValue
Since every valid HeaderName is a valid HeaderValue this is done infallibly.
Examples
let val = HeaderValue::from_name(ACCEPT); assert_eq!(val, HeaderValue::from_bytes(b"accept").unwrap());
pub fn from_bytes(src: &[u8]) -> Result<HeaderValue, InvalidHeaderValue>
[src]
Attempt to convert a byte slice to a HeaderValue
.
If the argument contains invalid header value bytes, an error is returned. Only byte values between 32 and 255 (inclusive) are permitted, excluding byte 127 (DEL).
This function is intended to be replaced in the future by a TryFrom
implementation once the trait is stabilized in std.
Examples
let val = HeaderValue::from_bytes(b"hello\xfa").unwrap(); assert_eq!(val, &b"hello\xfa"[..]);
An invalid value
let val = HeaderValue::from_bytes(b"\n"); assert!(val.is_err());
pub fn from_maybe_shared<T>(src: T) -> Result<HeaderValue, InvalidHeaderValue> where
T: AsRef<[u8]> + 'static,
[src]
T: AsRef<[u8]> + 'static,
Attempt to convert a Bytes
buffer to a HeaderValue
.
This will try to prevent a copy if the type passed is the type used internally, and will copy the data if it is not.
pub unsafe fn from_maybe_shared_unchecked<T>(src: T) -> HeaderValue where
T: AsRef<[u8]> + 'static,
[src]
T: AsRef<[u8]> + 'static,
Convert a Bytes
directly into a HeaderValue
without validating.
This function does NOT validate that illegal bytes are not contained within the buffer.
pub fn to_str(&self) -> Result<&str, ToStrError>
[src]
Yields a &str
slice if the HeaderValue
only contains visible ASCII
chars.
This function will perform a scan of the header value, checking all the characters.
Examples
let val = HeaderValue::from_static("hello"); assert_eq!(val.to_str().unwrap(), "hello");
pub fn len(&self) -> usize
[src]
Returns the length of self
.
This length is in bytes.
Examples
let val = HeaderValue::from_static("hello"); assert_eq!(val.len(), 5);
pub fn is_empty(&self) -> bool
[src]
Returns true if the HeaderValue
has a length of zero bytes.
Examples
let val = HeaderValue::from_static(""); assert!(val.is_empty()); let val = HeaderValue::from_static("hello"); assert!(!val.is_empty());
pub fn as_bytes(&self) -> &[u8]ⓘ
[src]
Converts a HeaderValue
to a byte slice.
Examples
let val = HeaderValue::from_static("hello"); assert_eq!(val.as_bytes(), b"hello");
pub fn set_sensitive(&mut self, val: bool)
[src]
Mark that the header value represents sensitive information.
Examples
let mut val = HeaderValue::from_static("my secret"); val.set_sensitive(true); assert!(val.is_sensitive()); val.set_sensitive(false); assert!(!val.is_sensitive());
pub fn is_sensitive(&self) -> bool
[src]
Returns true
if the value represents sensitive data.
Sensitive data could represent passwords or other data that should not be stored on disk or in memory. By marking header values as sensitive, components using this crate can be instructed to treat them with special care for security reasons. For example, caches can avoid storing sensitive values, and HPACK encoders used by HTTP/2.0 implementations can choose not to compress them.
Additionally, sensitive values will be masked by the Debug
implementation of HeaderValue
.
Note that sensitivity is not factored into equality or ordering.
Examples
let mut val = HeaderValue::from_static("my secret"); val.set_sensitive(true); assert!(val.is_sensitive()); val.set_sensitive(false); assert!(!val.is_sensitive());
Trait Implementations
impl AsRef<[u8]> for HeaderValue
[src]
impl Clone for HeaderValue
[src]
pub fn clone(&self) -> HeaderValue
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for HeaderValue
[src]
impl Eq for HeaderValue
[src]
impl<'a> From<&'a HeaderValue> for HeaderValue
[src]
pub fn from(t: &'a HeaderValue) -> HeaderValue
[src]
impl From<HeaderName> for HeaderValue
[src]
pub fn from(h: HeaderName) -> HeaderValue
[src]
impl From<i16> for HeaderValue
[src]
pub fn from(num: i16) -> HeaderValue
[src]
impl From<i32> for HeaderValue
[src]
pub fn from(num: i32) -> HeaderValue
[src]
impl From<i64> for HeaderValue
[src]
pub fn from(num: i64) -> HeaderValue
[src]
impl From<isize> for HeaderValue
[src]
pub fn from(num: isize) -> HeaderValue
[src]
impl From<u16> for HeaderValue
[src]
pub fn from(num: u16) -> HeaderValue
[src]
impl From<u32> for HeaderValue
[src]
pub fn from(num: u32) -> HeaderValue
[src]
impl From<u64> for HeaderValue
[src]
pub fn from(num: u64) -> HeaderValue
[src]
impl From<usize> for HeaderValue
[src]
pub fn from(num: usize) -> HeaderValue
[src]
impl FromStr for HeaderValue
[src]
type Err = InvalidHeaderValue
The associated error which can be returned from parsing.
pub fn from_str(s: &str) -> Result<HeaderValue, <HeaderValue as FromStr>::Err>
[src]
impl Hash for HeaderValue
[src]
pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for HeaderValue
[src]
pub fn cmp(&self, other: &HeaderValue) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<'a, T> PartialEq<&'a T> for HeaderValue where
T: ?Sized,
HeaderValue: PartialEq<T>,
[src]
T: ?Sized,
HeaderValue: PartialEq<T>,
pub fn eq(&self, other: &&'a T) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<[u8]> for HeaderValue
[src]
pub fn eq(&self, other: &[u8]) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<HeaderValue> for HeaderValue
[src]
pub fn eq(&self, other: &HeaderValue) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> PartialEq<HeaderValue> for &'a HeaderValue
[src]
pub fn eq(&self, other: &HeaderValue) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<HeaderValue> for [u8]
[src]
pub fn eq(&self, other: &HeaderValue) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<String> for HeaderValue
[src]
pub fn eq(&self, other: &String) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<str> for HeaderValue
[src]
pub fn eq(&self, other: &str) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, T> PartialOrd<&'a T> for HeaderValue where
T: ?Sized,
HeaderValue: PartialOrd<T>,
[src]
T: ?Sized,
HeaderValue: PartialOrd<T>,
pub fn partial_cmp(&self, other: &&'a T) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<[u8]> for HeaderValue
[src]
pub fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> PartialOrd<HeaderValue> for &'a HeaderValue
[src]
pub fn partial_cmp(&self, other: &HeaderValue) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<HeaderValue> for HeaderValue
[src]
pub fn partial_cmp(&self, other: &HeaderValue) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<HeaderValue> for [u8]
[src]
pub fn partial_cmp(&self, other: &HeaderValue) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<String> for HeaderValue
[src]
pub fn partial_cmp(&self, other: &String) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<str> for HeaderValue
[src]
pub fn partial_cmp(&self, other: &str) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> TryFrom<&'a [u8]> for HeaderValue
[src]
type Error = InvalidHeaderValue
The type returned in the event of a conversion error.
pub fn try_from(
t: &'a [u8]
) -> Result<HeaderValue, <HeaderValue as TryFrom<&'a [u8]>>::Error>
[src]
t: &'a [u8]
) -> Result<HeaderValue, <HeaderValue as TryFrom<&'a [u8]>>::Error>
impl<'a> TryFrom<&'a String> for HeaderValue
[src]
type Error = InvalidHeaderValue
The type returned in the event of a conversion error.
pub fn try_from(
s: &'a String
) -> Result<HeaderValue, <HeaderValue as TryFrom<&'a String>>::Error>
[src]
s: &'a String
) -> Result<HeaderValue, <HeaderValue as TryFrom<&'a String>>::Error>
impl<'a> TryFrom<&'a str> for HeaderValue
[src]
type Error = InvalidHeaderValue
The type returned in the event of a conversion error.
pub fn try_from(
t: &'a str
) -> Result<HeaderValue, <HeaderValue as TryFrom<&'a str>>::Error>
[src]
t: &'a str
) -> Result<HeaderValue, <HeaderValue as TryFrom<&'a str>>::Error>
impl TryFrom<String> for HeaderValue
[src]
type Error = InvalidHeaderValue
The type returned in the event of a conversion error.
pub fn try_from(
t: String
) -> Result<HeaderValue, <HeaderValue as TryFrom<String>>::Error>
[src]
t: String
) -> Result<HeaderValue, <HeaderValue as TryFrom<String>>::Error>
impl TryFrom<Vec<u8, Global>> for HeaderValue
[src]
type Error = InvalidHeaderValue
The type returned in the event of a conversion error.
pub fn try_from(
vec: Vec<u8, Global>
) -> Result<HeaderValue, <HeaderValue as TryFrom<Vec<u8, Global>>>::Error>
[src]
vec: Vec<u8, Global>
) -> Result<HeaderValue, <HeaderValue as TryFrom<Vec<u8, Global>>>::Error>
Auto Trait Implementations
impl RefUnwindSafe for HeaderValue
impl Send for HeaderValue
impl Sync for HeaderValue
impl Unpin for HeaderValue
impl UnwindSafe for HeaderValue
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,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CallHasher for T where
T: Hash,
[src]
T: Hash,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
[src]
pub const ALIGN: usize
[src]
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
[src]
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
[src]
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
[src]
pub unsafe fn drop(ptr: usize)
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
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.
pub 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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,