Struct SessionKey 

pub struct SessionKey(/* private fields */);

A 128-bit session identifier.

Implementations

impl SessionKey

pub const ENCODED_LEN: usize = 22usize

Length of a Base64 string returned by the encode method.

pub fn generate() -> SessionKey

Returns a random SessionKey, generated from ThreadRng.

Alternatively, you may wish to use generate_from_rng and pass your own CSPRNG. See ThreadRng’s documentation for notes on security.

pub fn generate_from_rng<R: TryCryptoRng>(rng: &mut R) -> SessionKey

Returns a random SessionKey, generated from rng.

Alternatively, you may wish to use generate. See its documentation for more.

Panics

If the RNG passed is fallible and yields an error, this function will panic.

pub fn encode(&self) -> String

Encodes this session key as a URL-safe Base64 string with no padding.

The returned string uses the URL-safe and filename-safe alphabet (with - and _) specified in RFC 4648.

pub fn decode<B: AsRef<[u8]>>(b: B) -> Result<SessionKey, DecodeSessionKeyError>

Decodes a session key string encoded with the URL-safe Base64 alphabet specified in RFC 4648. There must be no padding present in the input.

Trait Implementations

impl Clone for SessionKey

fn clone(&self) -> SessionKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionKey

Debug implementation does not leak secret

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

Formats the value using the given formatter.

impl Hash for SessionKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SessionKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SessionKey

impl StructuralPartialEq for SessionKey