[][src]Struct http_guest::header::HeaderValue

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]

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");

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());

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());

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());

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.

Convert a Bytes directly into a HeaderValue without validating.

This function does NOT validate that illegal bytes are not contained within the buffer.

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");

Returns the length of self.

This length is in bytes.

Examples

let val = HeaderValue::from_static("hello");
assert_eq!(val.len(), 5);

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());

Converts a HeaderValue to a byte slice.

Examples

let val = HeaderValue::from_static("hello");
assert_eq!(val.as_bytes(), b"hello");

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());

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]

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl Eq for HeaderValue
[src]

impl FromStr for HeaderValue
[src]

The associated error which can be returned from parsing.

impl Clone for HeaderValue
[src]

Performs copy-assignment from source. Read more

impl<'a> PartialOrd<HeaderValue> for &'a HeaderValue
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl PartialOrd<str> for HeaderValue
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl PartialOrd<String> for HeaderValue
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<'a, T> PartialOrd<&'a T> for HeaderValue where
    T: ?Sized,
    HeaderValue: PartialOrd<T>, 
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl PartialOrd<HeaderValue> for HeaderValue
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl PartialOrd<[u8]> for HeaderValue
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

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

Associated error with the conversion this implementation represents.

impl HttpTryFrom<i64> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl<'a> HttpTryFrom<&'a HeaderValue> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

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

Associated error with the conversion this implementation represents.

impl HttpTryFrom<isize> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<String> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<u64> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<HeaderValue> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<i16> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<u16> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<u32> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<i32> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<Bytes> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<usize> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl HttpTryFrom<HeaderName> for HeaderValue
[src]

Associated error with the conversion this implementation represents.

impl Debug for HeaderValue
[src]

impl From<i64> for HeaderValue
[src]

impl From<i32> for HeaderValue
[src]

impl From<u64> for HeaderValue
[src]

impl From<i16> for HeaderValue
[src]

impl From<usize> for HeaderValue
[src]

impl From<isize> for HeaderValue
[src]

impl From<HeaderName> for HeaderValue
[src]

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

impl From<u32> for HeaderValue
[src]

impl From<u16> for HeaderValue
[src]

impl Hash for HeaderValue
[src]

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

impl PartialEq<String> for HeaderValue
[src]

This method tests for !=.

impl PartialEq<[u8]> for HeaderValue
[src]

This method tests for !=.

impl PartialEq<str> for HeaderValue
[src]

This method tests for !=.

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

This method tests for !=.

impl PartialEq<HeaderValue> for HeaderValue
[src]

This method tests for !=.

impl<'a, T> PartialEq<&'a T> for HeaderValue where
    T: ?Sized,
    HeaderValue: PartialEq<T>, 
[src]

This method tests for !=.

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

Auto Trait Implementations

impl Send for HeaderValue

impl Sync for HeaderValue

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]