Enum jws::header::AvailableHeaders

pub enum AvailableHeaders<T> {
    Both {
        protected: T,
        unprotected: T,
    },
    ProtectedOnly(T),
    UnprotectedOnly(T),
}

The available message headers.

The message might have a protected header and/or an unprotected header. However, it must always have atleast one of the two.

Variants

Both

Fields

protected: T

unprotected: T

ProtectedOnly(T)

UnprotectedOnly(T)

Implementations

impl<'a> AvailableHeaders<&'a BTreeMap<String, Value, Global>>

pub fn protected(&self) -> Option<&'a HeaderMap>

Get the protected header, if it is available.

pub fn unprotected(&self) -> Option<&'a HeaderMap>

Get the unprotected header, if it is available.

pub fn get(&self, key: &str) -> Option<&'a JsonValue>

Get a parameter from either the protected or unprotected header, depending on which are available and which has the parameter.

If a parameter is found in the protected header, the unprotected header is not consulted anymore.

pub fn get_required(&self, key: &str) -> Result<&'a JsonValue>

Get a required parameter from either header.

This is almost identical to get, except that this function returns a properly formatter error instead of an empty optional.

pub fn deserialize_required<T: Deserialize<'a> + 'a>(
    &self,
    key: &str
) -> Result<T>

Get and deserialize a required parameter from either header.

This function delegates to get_required and deserializes the result into the desired type. Deserialization errors are reported as error::InvalidHeaderParam errors.

impl<'a> AvailableHeaders<&'a mut BTreeMap<String, Value, Global>>

pub fn insert<T>(&mut self, key: String, value: T) -> Option<JsonValue>where
    JsonValue: From<T>,

Insert a value into either of the available headers.

If the protected header is available, the value is inserted into that one. Otherwise, it is inserted into the unprotected header.

If the value is inserted into the protected header but the key exists in the unprotected header, it is removed from the unprotected header.

pub fn remove<Q>(&mut self, key: &Q) -> Option<JsonValue>where
    String: Borrow<Q>,
    Q: Ord + ?Sized,

Remove a key from all available headers.

This returns the erased value, if any. If the key exists in both headers, the value from the protected header is returned.

Trait Implementations

impl<T: Clone> Clone for AvailableHeaders<T>

fn clone(&self) -> AvailableHeaders<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Deref for AvailableHeaders<&'a mut T>

type Target = AvailableHeaders<&'a T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Copy> Copy for AvailableHeaders<T>