Struct PossiblePlaintext

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

A possible plaintext. The PossiblePlaintext struct provides utilities for analyzing and scoring texts that may be plaintexts. This is useful for brute-forcing ciphers, when you need a system to find the decryption outputs that are most likely to be correct.

Implementations

impl PossiblePlaintext

pub fn new(plaintext: &str) -> Self

Creates a new PossiblePlaintext with the given text as the possible plaintext.

Parameters

• plaintext - The possible plaintext.

Returns

The created PossiblePlaintext object

pub fn score(&self) -> f64

Returns the “score” of this plaintext. The score is based on cryptographic analysis, and a higher score indicates a better plaintext. The score is calculated from:

• Index of coincidence
• Monogram Frequency
• Bigram Frequency
• Trigram Frequency
• Quadram Frequency

pub fn text(&self) -> &str

Returns the original text of this plaintext.

Returns

A reference to the stored text in this plaintext.

pub fn best<T: AsRef<str>>(plaintexts: &[T]) -> Option<String>

Returns the best plaintext from the given slice based on cryptographic analysis. To get the best n plaintexts, use Plaintexts::best_n.

Parameters

• plaintexts - The plaintexts to find the best of

Returns

The best plaintext of the given slice, or None if it’s empty.

pub fn best_n<T: AsRef<str>>(plaintexts: &[T], n: usize) -> Result<Vec<String>>

Returns the most top n plaintexts in order from best to worst based on cryptographic analysis. To get only the best one, use Plaintext::best.

Parameters

• plaintexts - The plaintexts to find the best of
• n - The number of best plaintexts to return

Returns

The n best plaintexts in order from best to worst.

Errors

If the given n is greater than the number of plaintexts (or 0), or if the given plaintext slice is empty.

Trait Implementations

impl Clone for PossiblePlaintext

fn clone(&self) -> PossiblePlaintext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PossiblePlaintext

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

Formats the value using the given formatter.

impl Hash for PossiblePlaintext

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 Ord for PossiblePlaintext

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PossiblePlaintext

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for PossiblePlaintext

impl StructuralPartialEq for PossiblePlaintext