identity_verification::jose::jws

Struct JwsHeader

pub struct JwsHeader { /* private fields */ }
Expand description

JSON Web Signature JOSE Header.

More Info

Implementations§

§

impl JwsHeader

pub const fn new() -> JwsHeader

Create a new empty JwsHeader.

pub fn alg(&self) -> Option<JwsAlgorithm>

Returns the value for the algorithm claim (alg).

pub fn set_alg(&mut self, value: impl Into<JwsAlgorithm>)

Sets a value for the algorithm claim (alg).

pub fn b64(&self) -> Option<bool>

Returns the value of the base64url-encode payload claim (b64).

pub fn set_b64(&mut self, value: impl Into<bool>)

Sets a value for the base64url-encode payload claim (b64).

pub fn custom(&self) -> Option<&BTreeMap<String, Value>>

Returns the additional parameters in the header.

pub fn set_custom(&mut self, value: BTreeMap<String, Value>)

Sets additional parameters in the header.

pub fn has(&self, claim: &str) -> bool

Returns true if the header contains the given claim, false otherwise.

pub fn is_disjoint(&self, other: &JwsHeader) -> bool

Returns true if none of the fields are set in both self and other.

Methods from Deref<Target = JwtHeader>§

pub fn jku(&self) -> Option<&Url>

Returns the value of the JWK Set URL claim (jku).

pub fn set_jku(&mut self, value: impl Into<Url>)

Sets a value for the JWK Set URL claim (jku).

pub fn jwk(&self) -> Option<&Jwk>

Returns the value of the JWK claim (jwk).

pub fn set_jwk(&mut self, value: impl Into<Jwk>)

Sets a value for the JWK claim (jwk).

pub fn kid(&self) -> Option<&str>

Returns the value of the key ID claim (kid).

pub fn set_kid(&mut self, value: impl Into<String>)

Sets a value for the key ID claim (kid).

pub fn x5u(&self) -> Option<&Url>

Returns the value of the X.509 URL claim (x5u).

pub fn set_x5u(&mut self, value: impl Into<Url>)

Sets a value for the X.509 URL claim (x5u).

pub fn x5c(&self) -> Option<&[String]>

Returns the value of the X.509 certificate chain claim (x5c).

pub fn set_x5c(&mut self, value: impl IntoIterator<Item = impl Into<String>>)

Sets values for the X.509 certificate chain claim (x5c).

pub fn x5t(&self) -> Option<&str>

Returns the value of the X.509 certificate SHA-1 thumbprint claim (x5t).

pub fn set_x5t(&mut self, value: impl Into<String>)

Sets a value for the X.509 certificate SHA-1 thumbprint claim (x5t).

pub fn x5t_s256(&self) -> Option<&str>

Returns the value of the X.509 certificate SHA-256 thumbprint claim (x5t#S256).

pub fn set_x5t_s256(&mut self, value: impl Into<String>)

Sets a value for the X.509 certificate SHA-256 thumbprint claim (x5t#S256).

pub fn typ(&self) -> Option<&str>

Returns the value of the token type claim (typ).

pub fn set_typ(&mut self, value: impl Into<String>)

Sets a value for the token type claim (typ).

pub fn cty(&self) -> Option<&str>

Returns the value of the content type claim (cty).

pub fn set_cty(&mut self, value: impl Into<String>)

Sets a value for the content type claim (cty).

pub fn crit(&self) -> Option<&[String]>

Returns the value of the critical claim (crit).

pub fn set_crit(&mut self, value: impl IntoIterator<Item = impl Into<String>>)

Sets values for the critical claim (crit).

pub fn url(&self) -> Option<&Url>

Returns the value of the url claim (url).

pub fn set_url(&mut self, value: impl Into<Url>)

Sets a value for the url claim (url).

pub fn nonce(&self) -> Option<&str>

Returns the value of the nonce claim (nonce).

pub fn set_nonce(&mut self, value: impl Into<String>)

Sets a value for the nonce claim (nonce).

pub fn has(&self, claim: &str) -> bool

Returns true if the header contains the given claim, false otherwise.

pub fn is_disjoint(&self, other: &JwtHeader) -> bool

Returns true if none of the fields are set in both self and other.

Trait Implementations§

§

impl Clone for JwsHeader

§

fn clone(&self) -> JwsHeader

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for JwsHeader

§

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

Formats the value using the given formatter. Read more
§

impl Default for JwsHeader

§

fn default() -> JwsHeader

Returns the “default value” for a type. Read more
§

impl Deref for JwsHeader

§

type Target = JwtHeader

The resulting type after dereferencing.
§

fn deref(&self) -> &<JwsHeader as Deref>::Target

Dereferences the value.
§

impl DerefMut for JwsHeader

§

fn deref_mut(&mut self) -> &mut <JwsHeader as Deref>::Target

Mutably dereferences the value.
§

impl<'de> Deserialize<'de> for JwsHeader

§

fn deserialize<__D>( __deserializer: __D, ) -> Result<JwsHeader, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl JoseHeader for JwsHeader

§

fn common(&self) -> &JwtHeader

Returns the header common to all [JoseHeader]s.
§

fn has_claim(&self, claim: &str) -> bool

Returns true if the header has the given claim, false otherwise.
§

impl PartialEq for JwsHeader

§

fn eq(&self, other: &JwsHeader) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl Serialize for JwsHeader

§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl Eq for JwsHeader

§

impl StructuralPartialEq for JwsHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
§

impl<T> FmtJson for T
where T: ToJson,

§

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

Format this as a JSON string or pretty-JSON string based on whether the # format flag was used.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromJson for T
where T: for<'de> Deserialize<'de>,

§

fn from_json(json: &(impl AsRef<str> + ?Sized)) -> Result<Self, Error>

Deserialize Self from a string of JSON text.
§

fn from_json_slice(json: &(impl AsRef<[u8]> + ?Sized)) -> Result<Self, Error>

Deserialize Self from bytes of JSON text.
§

fn from_json_value(json: Value) -> Result<Self, Error>

Deserialize Self from a serde_json::Value.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> ToJson for T
where T: Serialize,

§

fn to_json(&self) -> Result<String, Error>

Serialize self as a string of JSON.
§

fn to_json_vec(&self) -> Result<Vec<u8>, Error>

Serialize self as a JSON byte vector.
§

fn to_json_value(&self) -> Result<Value, Error>

Serialize self as a serde_json::Value.
§

fn to_json_pretty(&self) -> Result<String, Error>

Serialize self as a pretty-printed string of JSON.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T