Struct Entropy 

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

Password entropy.

The entropy number used internally represents the number of base 2 entropy bits, and is calculated using log2(choices).

Implementations

impl Entropy

pub fn zero() -> Self

Construct entropy for zero bits, representing no entropy.

pub fn one() -> Self

Construct entropy for one bit, representing 50/50 chance.

pub fn from_bits<F: Into<f64>>(bits: F) -> Self

Construct entropy from a number of entropy bits.

pub fn from_real<F: Into<f64>>(real: F) -> Self

Construct entropy from a real number.

For a wordlist of 7776 words where choices are uniform, the real number 7776 may be given to construct the proper entropy value. This would produce an entropy instance with about 12.9 bits.

If Entropy should be constructed from a number of bits, use from_bits instead.

pub fn bits(self) -> f64

Get the number of entropy bits.

Examples found in repository

examples/passphrase_config.rs (line 37)

fn main() {
    // Build a custom configuration to:
    // - use hyphens as separator
    // - sometimes capitalizes whole passphrase words
    // - sometimes capitalizes the first characters of passphrase words
    // TODO: use the builder instead
    // let config = BasicConfigBuilder::default()
    //     .separator("-")
    //     .capitalize_first(Probability::from(0.33))
    //     .capitalize_words(Probability::half())
    //     .build()
    //     .unwrap();
    let mut config = BasicConfig::default();
    config.words = 8;
    config.separator = "-".into();
    config.capitalize_first = Probability::from(0.33);
    config.capitalize_words = Probability::half();

    let scheme = config.to_scheme();

    println!("Passphrase: {:?}", scheme.generate());
    println!("Entropy: {:?}", scheme.entropy().bits());
}

Trait Implementations

impl<B> Add<B> for Entropy

where B: Into<f64>,

type Output = Entropy

The resulting type after applying the + operator.

fn add(self, b: B) -> Entropy

Performs the + operation.

impl Add for Entropy

type Output = Entropy

The resulting type after applying the + operator.

fn add(self, Entropy: Entropy) -> Entropy

Performs the + operation.

impl Clone for Entropy

fn clone(&self) -> Entropy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entropy

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

Formats the value using the given formatter.

impl Display for Entropy

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

Formats the value using the given formatter.

impl<B> Div<B> for Entropy

where B: Into<f64>,

type Output = Entropy

The resulting type after applying the / operator.

fn div(self, b: B) -> Entropy

Performs the / operation.

impl Div for Entropy

type Output = Entropy

The resulting type after applying the / operator.

fn div(self, Entropy: Entropy) -> Entropy

Performs the / operation.

impl<B> Mul<B> for Entropy

where B: Into<f64>,

type Output = Entropy

The resulting type after applying the * operator.

fn mul(self, b: B) -> Entropy

Performs the * operation.

impl Mul for Entropy

type Output = Entropy

The resulting type after applying the * operator.

fn mul(self, Entropy: Entropy) -> Entropy

Performs the * operation.

impl PartialEq for Entropy

fn eq(&self, other: &Entropy) -> 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 PartialOrd for Entropy

fn partial_cmp(&self, other: &Entropy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<B> Sub<B> for Entropy

where B: Into<f64>,

type Output = Entropy

The resulting type after applying the - operator.

fn sub(self, b: B) -> Entropy

Performs the - operation.

impl Sub for Entropy

type Output = Entropy

The resulting type after applying the - operator.

fn sub(self, Entropy: Entropy) -> Entropy

Performs the - operation.

impl Sum for Entropy

fn sum<I>(iter: I) -> Self

where I: Iterator, I::Item: Into<Entropy>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Entropy

impl StructuralPartialEq for Entropy