Struct mini_http::header::HeaderValue
[−]
[src]
pub struct HeaderValue { /* fields omitted */ }
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.
Methods
impl HeaderValue
[src]
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");
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());
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());
[src]
Attempt to convert a Bytes
buffer 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.
[src]
Convert a Bytes
directly into a HeaderValue
without validating.
This function does NOT validate that illegal bytes are not contained within the buffer.
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");
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);
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());
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");
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());
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. This setting can be used by components
like caches to avoid storing the value. HPACK encoders must set the
header field to never index when is_sensitive
returns true.
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 Ord for HeaderValue
[src]
fn cmp(&self, other: &HeaderValue) -> Ordering
[src]
impl Hash for HeaderValue
[src]
impl Clone for HeaderValue
[src]
fn clone(&self) -> HeaderValue
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq<[u8]> for HeaderValue
[src]
fn eq(&self, other: &[u8]) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialEq<str> for HeaderValue
[src]
fn eq(&self, other: &str) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl<'a, T> PartialEq<&'a T> for HeaderValue where
T: ?Sized,
HeaderValue: PartialEq<T>,
[src]
T: ?Sized,
HeaderValue: PartialEq<T>,
fn eq(&self, other: &&'a T) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl<'a> PartialEq<HeaderValue> for &'a HeaderValue
[src]
fn eq(&self, other: &HeaderValue) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialEq<String> for HeaderValue
[src]
fn eq(&self, other: &String) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialEq<HeaderValue> for HeaderValue
[src]
fn eq(&self, other: &HeaderValue) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl FromStr for HeaderValue
[src]
type Err = InvalidHeaderValue
fn from_str(s: &str) -> Result<HeaderValue, <HeaderValue as FromStr>::Err>
[src]
impl Debug for HeaderValue
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter.
impl Eq for HeaderValue
[src]
impl AsRef<[u8]> for HeaderValue
[src]
impl<'a> HttpTryFrom<&'a str> for HeaderValue
[src]
type Error = InvalidHeaderValue
fn try_from(
t: &'a str
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<&'a str>>::Error>
[src]
t: &'a str
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<&'a str>>::Error>
impl HttpTryFrom<HeaderValue> for HeaderValue
[src]
type Error = Error
fn try_from(
t: HeaderValue
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<HeaderValue>>::Error>
[src]
t: HeaderValue
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<HeaderValue>>::Error>
impl HttpTryFrom<Bytes> for HeaderValue
[src]
type Error = InvalidHeaderValueBytes
fn try_from(
bytes: Bytes
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<Bytes>>::Error>
[src]
bytes: Bytes
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<Bytes>>::Error>
impl<'a> HttpTryFrom<&'a [u8]> for HeaderValue
[src]
type Error = InvalidHeaderValue
fn try_from(
t: &'a [u8]
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<&'a [u8]>>::Error>
[src]
t: &'a [u8]
) -> Result<HeaderValue, <HeaderValue as HttpTryFrom<&'a [u8]>>::Error>
impl PartialOrd<String> for HeaderValue
[src]
fn partial_cmp(&self, other: &String) -> Option<Ordering>
[src]
impl<'a> PartialOrd<HeaderValue> for &'a HeaderValue
[src]
fn partial_cmp(&self, other: &HeaderValue) -> Option<Ordering>
[src]
impl PartialOrd<[u8]> for HeaderValue
[src]
impl PartialOrd<HeaderValue> for HeaderValue
[src]
fn partial_cmp(&self, other: &HeaderValue) -> Option<Ordering>
[src]
impl<'a, T> PartialOrd<&'a T> for HeaderValue where
T: ?Sized,
HeaderValue: PartialOrd<T>,
[src]
T: ?Sized,
HeaderValue: PartialOrd<T>,