Struct ApiKeyConfig 

#[non_exhaustive]
pub struct ApiKeyConfig {
    pub prefix: String,
    pub secret_length: usize,
    pub touch_threshold_secs: u64,
}

Configuration for the API key module.

Deserialised from the apikey key in the application YAML config. All fields have defaults, so an empty apikey: block is valid.

YAML example

apikey:
  prefix: "modo"
  secret_length: 32
  touch_threshold_secs: 60

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

prefix: String

Key prefix prepended before the underscore separator. Must be [a-zA-Z0-9], 1-20 characters. Defaults to "modo".

secret_length: usize

Length of the random secret portion in base62 characters. Minimum 16. Defaults to 32.

touch_threshold_secs: u64

Minimum interval between last_used_at updates, in seconds. Defaults to 60 (1 minute).

Implementations

impl ApiKeyConfig

pub fn validate(&self) -> Result<()>

Validate the configuration.

Errors

Returns Error::bad_request if the prefix is invalid or secret length is too short.

Trait Implementations

impl Clone for ApiKeyConfig

fn clone(&self) -> ApiKeyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyConfig

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

Formats the value using the given formatter.

impl Default for ApiKeyConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiKeyConfig

where ApiKeyConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.