Skip to main content

JsonWebToken

Struct JsonWebToken 

Source
pub struct JsonWebToken<P> { /* private fields */ }
Expand description

JWT codec backed by the jsonwebtoken crate.

This is the main codec implementation provided by the crate.

§Key management

The default constructor uses built-in ES384 development keys. This is convenient for tests or local development.

For persistent sessions across restarts or multiple instances, construct the codec with explicit keys via JsonWebToken::new_with_options.

Implementations§

Source§

impl<P> JsonWebToken<P>

Source

pub fn new_with_options(options: JsonWebTokenOptions) -> Self

Creates a codec from explicit options.

Use this when you need explicit signing or verification configuration.

Source

pub fn key_id(&self) -> &str

Returns the signing kid used by this codec.

Source

pub fn verification_key_count(&self) -> usize

Returns the number of currently configured verification keys.

Source

pub fn has_verification_key(&self, kid: &str) -> bool

Returns whether a verification key for the given kid exists.

Source

pub fn allows_missing_kid_fallback(&self) -> bool

Returns whether this codec allows verification without kid.

Source

pub fn replace_verification_keys( &self, keys: HashMap<String, DecodingKey>, allow_missing_kid_fallback: bool, )

Atomically replaces all verification keys.

Source

pub fn replace_verification_keys_from_jwks( &self, keys: &[EcP384Jwk], allow_missing_kid_fallback: bool, ) -> Result<()>

Atomically replaces all verification keys from canonical ES384 JWK entries.

§Errors

Returns an error when any provided key cannot be converted.

Trait Implementations§

Source§

impl<P: Clone> Clone for JsonWebToken<P>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P> Codec for JsonWebToken<P>

Source§

type Payload = P

Type of the payload being encoded/decoded.
Source§

fn encode(&self, payload: &Self::Payload) -> Result<Vec<u8>>

Encodes a payload into an opaque, implementation-defined byte vector. Read more
Source§

fn decode(&self, encoded_value: &[u8]) -> Result<Self::Payload>

Decodes a previously encoded payload. Read more
Source§

impl<P> Default for JsonWebToken<P>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<P> Freeze for JsonWebToken<P>

§

impl<P> RefUnwindSafe for JsonWebToken<P>
where P: RefUnwindSafe,

§

impl<P> Send for JsonWebToken<P>
where P: Send,

§

impl<P> Sync for JsonWebToken<P>
where P: Sync,

§

impl<P> Unpin for JsonWebToken<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for JsonWebToken<P>

§

impl<P> UnwindSafe for JsonWebToken<P>
where P: UnwindSafe,

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, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more