Struct jsonwebtoken::Header

pub struct Header {
    pub typ: Option<String>,
    pub alg: Algorithm,
    pub cty: Option<String>,
    pub jku: Option<String>,
    pub kid: Option<String>,
    pub x5u: Option<String>,
    pub x5t: Option<String>,
}

A basic JWT header, the alg defaults to HS256 and typ is automatically set to JWT. All the other fields are optional.

Fields

typ: Option<String>

The type of JWS: it can only be "JWT" here

Defined in RFC7515#4.1.9.

alg: Algorithm

The algorithm used

Defined in RFC7515#4.1.1.

cty: Option<String>

Content type

Defined in RFC7519#5.2.

jku: Option<String>

JSON Key URL

Defined in RFC7515#4.1.2.

kid: Option<String>

Key ID

Defined in RFC7515#4.1.4.

x5u: Option<String>

X.509 URL

Defined in RFC7515#4.1.5.

x5t: Option<String>

X.509 certificate thumbprint

Defined in RFC7515#4.1.7.

Methods

impl Header

pub fn new(algorithm: Algorithm) -> Header

Returns a JWT header with the algorithm given

Trait Implementations

impl Debug for Header

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

Formats the value using the given formatter.

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Header

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for Header

fn default() -> Self

Returns a JWT header using the default Algorithm, HS256