Type Alias PublicJsonWebKey

pub type PublicJsonWebKey = JsonWebKey<JsonWebKeyPublicParameters>;

Aliased Type

struct PublicJsonWebKey { /* private fields */ }

Implementations

impl<P> JsonWebKey<P>

pub const fn new(parameters: P) -> Self

Create a new JsonWebKey with the given parameters.

pub fn try_map<M, O, E>(self, mapper: M) -> Result<JsonWebKey<O>, E>

where M: FnOnce(P) -> Result<O, E>,

Map the parameters of this JsonWebKey to a new type, with a fallible mapper, consuming the original key.

Errors

Returns an error if the mapper returns an error.

pub fn map<M, O>(self, mapper: M) -> JsonWebKey<O>

where M: FnOnce(P) -> O,

Map the parameters of this JsonWebKey to a new type, consuming the original key.

pub fn try_cloned_map<M, O, E>(&self, mapper: M) -> Result<JsonWebKey<O>, E>

where M: FnOnce(&P) -> Result<O, E>,

Map the parameters of this JsonWebKey to a new type, with a fallible mapper, cloning the other fields.

Errors

Returns an error if the mapper returns an error.

pub fn cloned_map<M, O>(&self, mapper: M) -> JsonWebKey<O>

where M: FnOnce(&P) -> O,

Map the parameters of this JsonWebKey to a new type, cloning the other fields.

pub fn with_use(self, value: JsonWebKeyUse) -> Self

Set the use field of this JsonWebKey.

pub fn with_key_ops(self, key_ops: Vec<JsonWebKeyOperation>) -> Self

Set the key_ops field of this JsonWebKey.

pub fn with_alg(self, alg: JsonWebSignatureAlg) -> Self

Set the alg field of this JsonWebKey.

pub fn with_kid(self, kid: impl Into<String>) -> Self

Set the kid field of this JsonWebKey.

pub const fn alg(&self) -> Option<&JsonWebSignatureAlg>

Get the kid field of this JsonWebKey, if set.

pub const fn params(&self) -> &P

Get the inner parameters of this JsonWebKey.

Trait Implementations

impl TryFrom<JsonWebKey<JsonWebKeyPrivateParameters>> for PublicJsonWebKey

type Error = SymetricKeyError

The type returned in the event of a conversion error.

fn try_from(value: PrivateJsonWebKey) -> Result<Self, Self::Error>

Performs the conversion.

impl<P: Clone> Clone for JsonWebKey<P>

fn clone(&self) -> JsonWebKey<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Constrainable for JsonWebKey<P>

where P: ParametersInfo,

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

Key ID (kid) of this key

fn kty(&self) -> JsonWebKeyType

Key type (kty) of this key

fn algs(&self) -> &[JsonWebSignatureAlg]

List of available algorithms for this key

fn alg(&self) -> Option<&JsonWebSignatureAlg>

fn use_(&self) -> Option<&JsonWebKeyUse>

Usage specified for this key

impl<P: Debug> Debug for JsonWebKey<P>

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for JsonWebKey<P>

where P: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: JsonSchema> JsonSchema for JsonWebKey<P>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<P: PartialEq> PartialEq for JsonWebKey<P>

fn eq(&self, other: &JsonWebKey<P>) -> 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<P> Serialize for JsonWebKey<P>

where P: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: Eq> Eq for JsonWebKey<P>

impl<P> StructuralPartialEq for JsonWebKey<P>