Struct textnonce::TextNonce

pub struct TextNonce(pub String);

A nonce is a cryptographic concept of an arbitrary number that is never used more than once.

TextNonce is a nonce because the first 16 characters represents the current time, which will never have been generated before, nor will it be generated again, across the period of time in which a Timespec (or chrono::DateTime) is valid.

TextNonce additionally includes bytes of randomness, making it difficult to predict. This makes it suitable to be used for session IDs.

It is also text-based, using only characters in the base64 character set.

Methods

impl TextNonce

pub fn new() -> TextNonce

Generate a new TextNonce with 16 characters of time and 16 characters of randomness

pub fn sized(length: usize) -> Result<TextNonce, String>

Generate a new TextNonce. length must be at least 16, and divisible by 4. The first 16 characters come from the time component, and all characters after that will be random.

pub fn sized_urlsafe(length: usize) -> Result<TextNonce, String>

Generate a new TextNonce using the URL_SAFE variant of base64 (using '_' and '-') length must be at least 16, and divisible by 4. The first 16 characters come from the time component, and all characters after that will be random.

pub fn sized_configured(
    length: usize,
    config: Config
) -> Result<TextNonce, String>

Generate a new TextNonce specifying the Base64 configuration to use. length must be at least 16, and divisible by 4. The first 16 characters come from the time component, and all characters after that will be random.

pub fn into_string(self) -> String

Trait Implementations

impl PartialEq<TextNonce> for TextNonce

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

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

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

This method tests for !=.

impl Clone for TextNonce

fn clone(&self) -> TextNonce

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TextNonce

fn default() -> TextNonce

Returns the "default value" for a type.

impl Deref for TextNonce

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Debug for TextNonce

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

Formats the value using the given formatter.

impl Display for TextNonce

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

Formats the value using the given formatter.

impl Serialize for TextNonce

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for TextNonce

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.