Struct fire_http_representation::header::values::HeaderValues

pub struct HeaderValues(_);

Contains all http header values.

This is really similar to http::header::HeaderMap except that is uses IntoHeaderValue for inserting. And it does not allow multiples values for a given key.

Implementations

impl HeaderValues

pub fn new() -> Self

Creates a new empty HeaderValues.

pub fn from_inner(inner: HeaderMap<HeaderValue>) -> Self

Creates a new HeaderValues from it’s inner type.

pub fn insert<K, V>(&mut self, key: K, val: V) -> Option<HeaderValue>where
    K: IntoHeaderName,
    V: TryInto<HeaderValue>,
    V::Error: Debug,

Insert a new key and value into the header.

If a value to this key is already present that value is dropped.

Panics

If the value is not a valid HeaderValue.

pub fn try_insert<K, V>(
    &mut self,
    key: K,
    val: V
) -> Result<Option<HeaderValue>, InvalidHeaderValue>where
    K: IntoHeaderName,
    V: TryInto<HeaderValue, Error = InvalidHeaderValue>,

Insert a new key and value into the header. Returning None if the value is not valid.

If a value to this key is already present that value is dropped.

pub fn encode_value<K, V>(&mut self, key: K, val: V) -> Option<HeaderValue>where
    K: IntoHeaderName,
    V: IntoEncodedHeaderValue,

Insert a new key and value into the header. Percent encoding the value if necessary.

pub fn serialize_value<K, V: ?Sized>(
    &mut self,
    key: K,
    val: &V
) -> Result<Option<HeaderValue>, JsonError>where
    K: IntoHeaderName,
    V: Serialize,

Available on crate feature json only.

Insert a new key and a serializeable value. The value will be serialized as json and percent encoded.

Returns None if the value could not be serialized or inserted.

pub fn get<K>(&self, key: K) -> Option<&HeaderValue>where
    K: AsHeaderName,

Returns the value if it exists.

pub fn get_mut<K>(&mut self, key: K) -> Option<&mut HeaderValue>where
    K: AsHeaderName,

Returns the value mutably if it exists.

pub fn get_str<K>(&self, key: K) -> Option<&str>where
    K: AsHeaderName,

Returns the value as a string if it exists and is valid.

pub fn decode_value<K>(&self, key: K) -> Option<Cow<'_, str>>where
    K: AsHeaderName,

Returns the value percent decoded as a string if it exists and is valid.

pub fn deserialize_value<K, D>(&self, key: K) -> Option<D>where
    K: AsHeaderName,
    D: DeserializeOwned,

Available on crate feature json only.

Deserializes a given value. Returning None if the value does not exist or is not valid json.

pub fn into_inner(self) -> HeaderMap<HeaderValue>

Returns the inner HeaderMap.

Trait Implementations

impl Clone for HeaderValues

fn clone(&self) -> HeaderValues

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeaderValues

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.