Struct jsonwebtoken::EncodingKey
source · [−]pub struct EncodingKey { /* private fields */ }Expand description
A key to encode a JWT with. Can be a secret, a PEM-encoded key or a DER-encoded key. This key can be re-used so make sure you only initialize it once if you can for better performance
Implementations
sourceimpl EncodingKey
impl EncodingKey
sourcepub fn from_secret(secret: &[u8]) -> Self
pub fn from_secret(secret: &[u8]) -> Self
If you’re using a HMAC secret that is not base64, use that.
sourcepub fn from_base64_secret(secret: &str) -> Result<Self>
pub fn from_base64_secret(secret: &str) -> Result<Self>
If you have a base64 HMAC secret, use that.
sourcepub fn from_rsa_pem(key: &[u8]) -> Result<Self>
pub fn from_rsa_pem(key: &[u8]) -> Result<Self>
If you are loading a RSA key from a .pem file. This errors if the key is not a valid RSA key.
sourcepub fn from_ec_pem(key: &[u8]) -> Result<Self>
pub fn from_ec_pem(key: &[u8]) -> Result<Self>
If you are loading a ECDSA key from a .pem file This errors if the key is not a valid private EC key
sourcepub fn from_rsa_der(der: &[u8]) -> Self
pub fn from_rsa_der(der: &[u8]) -> Self
If you know what you’re doing and have the DER-encoded key, for RSA only
sourcepub fn from_ec_der(der: &[u8]) -> Self
pub fn from_ec_der(der: &[u8]) -> Self
If you know what you’re doing and have the DER-encoded key, for ECDSA
Trait Implementations
sourceimpl Clone for EncodingKey
impl Clone for EncodingKey
sourcefn clone(&self) -> EncodingKey
fn clone(&self) -> EncodingKey
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for EncodingKey
impl Debug for EncodingKey
sourceimpl PartialEq<EncodingKey> for EncodingKey
impl PartialEq<EncodingKey> for EncodingKey
sourcefn eq(&self, other: &EncodingKey) -> bool
fn eq(&self, other: &EncodingKey) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &EncodingKey) -> bool
fn ne(&self, other: &EncodingKey) -> bool
This method tests for !=.
impl StructuralPartialEq for EncodingKey
Auto Trait Implementations
impl RefUnwindSafe for EncodingKey
impl Send for EncodingKey
impl Sync for EncodingKey
impl Unpin for EncodingKey
impl UnwindSafe for EncodingKey
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more