Struct Jwk

#[non_exhaustive]
pub struct Jwk {
    pub kty: Option<String>,
    pub e: Option<String>,
    pub n: Option<String>,
    pub alg: Option<String>,
}

A JSON web key.

Struct that contains info for a JWK. A list of them for different kinds can be retrieved from the JWK endpoint (for example, <https://www.googleapis.com/oauth2/v3/certs>). The JWK is used to verify the JWT token.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kty: Option<String>

Key type parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.1.

e: Option<String>

RSA public exponent, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.

n: Option<String>

RSA modulus, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.

alg: Option<String>

Algorithm parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.4.

Implementations

impl Jwk

pub const KTY_FIELD: &'static MessageField

pub const E_FIELD: &'static MessageField

pub const N_FIELD: &'static MessageField

pub const ALG_FIELD: &'static MessageField

impl Jwk

pub fn path_builder() -> JwkFieldPathBuilder

impl Jwk

pub const fn const_default() -> Self

pub fn kty_opt_mut(&mut self) -> Option<&mut String>

If kty is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn kty_mut(&mut self) -> &mut String

Returns a mutable reference to kty. If the field is unset, it is first initialized with the default value.

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

If kty is set, returns Some with the value; otherwise returns None.

pub fn set_kty<T: Into<String>>(&mut self, field: T)

Sets kty with the provided value.

pub fn with_kty<T: Into<String>>(self, field: T) -> Self

Sets kty with the provided value.

pub fn e_opt_mut(&mut self) -> Option<&mut String>

If e is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn e_mut(&mut self) -> &mut String

Returns a mutable reference to e. If the field is unset, it is first initialized with the default value.

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

If e is set, returns Some with the value; otherwise returns None.

pub fn set_e<T: Into<String>>(&mut self, field: T)

Sets e with the provided value.

pub fn with_e<T: Into<String>>(self, field: T) -> Self

Sets e with the provided value.

pub fn n_opt_mut(&mut self) -> Option<&mut String>

If n is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn n_mut(&mut self) -> &mut String

Returns a mutable reference to n. If the field is unset, it is first initialized with the default value.

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

If n is set, returns Some with the value; otherwise returns None.

pub fn set_n<T: Into<String>>(&mut self, field: T)

Sets n with the provided value.

pub fn with_n<T: Into<String>>(self, field: T) -> Self

Sets n with the provided value.

pub fn alg_opt_mut(&mut self) -> Option<&mut String>

If alg is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn alg_mut(&mut self) -> &mut String

Returns a mutable reference to alg. If the field is unset, it is first initialized with the default value.

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

If alg is set, returns Some with the value; otherwise returns None.

pub fn set_alg<T: Into<String>>(&mut self, field: T)

Sets alg with the provided value.

pub fn with_alg<T: Into<String>>(self, field: T) -> Self

Sets alg with the provided value.

impl Jwk

pub fn kty(&self) -> &str

Returns the value of kty, or the default value if kty is unset.

pub fn e(&self) -> &str

Returns the value of e, or the default value if e is unset.

pub fn n(&self) -> &str

Returns the value of n, or the default value if n is unset.

pub fn alg(&self) -> &str

Returns the value of alg, or the default value if alg is unset.

Trait Implementations

impl Clone for Jwk

fn clone(&self) -> Jwk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Jwk

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

Formats the value using the given formatter.

impl Default for Jwk

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Jwk

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Jwk> for Jwk

fn from(_: Jwk) -> Self

Converts to this type from the input type.

impl Message for Jwk

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for Jwk

const FIELDS: &'static [&'static MessageField]

impl PartialEq for Jwk

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

Tests for self and other values to be equal, and is used by ==.

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 Jwk

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Jwk> for Jwk

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(_: &Jwk) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Jwk