Trait Encoder

Source

pub unsafe trait Encoder {
    const CHARSET: &[u8];
    const MIN_LEN: usize;
}

Expand description

Specifies parameters for encoding random data into a valid utf-8 String.

All provided implementations list their minimum secure length in the documentation of their unit struct, and it is highly recommended that custom implementations do the same.

§Safety

The CHARSET field must only contain valid ascii characters. Meaning that all u8 values must be in the interval [0, 128). Failure to uphold this condition will result in text methods returning invalid Strings’s.

The MIN_LEN field must be at least ceil(log_base(2¹²⁸)), where base is the length of the CHARSET field. Failure to uphold this condition will result in poor security of generated String’s.

Required Associated Constants§

Source

const CHARSET: &[u8]

The character set of the encoder implementation.

See trait-level docs for safety comments.

Source

const MIN_LEN: usize

Shortest length String that will contain at least 128 bits of randomness.

See trait-level docs for safety comments.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait EncoderCopy item path

§Safety

Required Associated Constants§

const CHARSET: &[u8]

const MIN_LEN: usize

Dyn Compatibility§

Implementors§

impl Encoder for Base16

const CHARSET: &[u8] = b"0123456789ABCDEF"

const MIN_LEN: usize = 32usize

impl Encoder for Base16Lowercase

const CHARSET: &[u8] = b"0123456789abcdef"

const MIN_LEN: usize = 32usize

impl Encoder for Base32

const CHARSET: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"

const MIN_LEN: usize = 26usize

impl Encoder for Base32Hex

const CHARSET: &[u8] = b"0123456789ABCDEFGHIJKLMNOPQRSTUV"

const MIN_LEN: usize = 26usize

impl Encoder for Base62

const CHARSET: &[u8] = crate::rng::ALPHANUMERIC

const MIN_LEN: usize = 22usize

impl Encoder for Base64

const CHARSET: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"

const MIN_LEN: usize = 22usize

impl Encoder for Base64URL

const CHARSET: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"

const MIN_LEN: usize = 22usize

Trait Encoder