Struct TokenSignerBuilder

pub struct TokenSignerBuilder<Claims, Algo>
where
    Algo: Algorithm,
{ /* private fields */ }

Builder for TokenSigner.

Implementations

impl<Claims, Algo> TokenSignerBuilder<Claims, Algo>

where Algo: Algorithm,

pub fn access_token_name<VALUE: Into<String>>(self, value: VALUE) -> Self

The name of the future access tokens.

For example, the name of the cookie generated in TokenSigner::create_access_cookie.

Defaults to "access_token"

pub fn access_token_lifetime(self, value: Duration) -> Self

The lifetime duration of the access token.

Defaults to Duration::from_secs(60)

pub fn refresh_token_name<VALUE: Into<String>>(self, value: VALUE) -> Self

The name of the future refresh tokens.

For example, the name of the cookie generated in TokenSigner::create_refresh_cookie.

Defaults to "refresh_token"

pub fn refresh_token_lifetime(self, value: Duration) -> Self

The lifetime duration of the refresh token.

Defaults to Duration::from_secs(30 * 60)

pub fn header(self, value: Header) -> Self

JWT Header used in the creation of access and refresh tokens.

Please refer to the structs own documentation for more details.

Defaults to Header::default()

pub fn algorithm(self, value: Algo) -> Self

The Cryptographic signing algorithm used in the process of creation of access and refresh tokens.

Please referee to the Supported algorithms section of the jwt-compact crate for a comprehensive list of the supported algorithms.

pub fn signing_key(self, value: Algo::SigningKey) -> Self

Key used to sign tokens.

pub fn time_options(self, value: TimeOptions) -> Self

Used in the creating of the token, the current time stamp is taken from this.

Please refer to the structs own documentation for more details.

Defaults to TimeOptions::from_leeway(Duration::seconds(0))

pub fn build(self) -> Result<TokenSigner<Claims, Algo>, TokenSignerBuilderError>

Builds a new TokenSigner.

Errors

If a required field has not been initialized.

Trait Implementations

impl<Claims, Algo> Default for TokenSignerBuilder<Claims, Algo>

where Algo: Algorithm,

fn default() -> Self

Returns the “default value” for a type.