Struct ultra::Enigma

pub struct Enigma { /* fields omitted */ }

Represents an Enigma machine with rotor, key, and ring settings.

Implementations

impl Enigma

pub fn new(
    rotors: &str,
    keys: &str,
    rings: &str,
    reflector: char,
    plugboard: &str
) -> Enigma

Creates a new Enigma, where rotors is a string of three digits ranging from 1-8 (corresponding to rotors I through VIII of the real Enigma machine), keys and rings are three character strings containing the key and ring settings, reflector is one of 'A', 'B', or 'C', and plugboard is a string of whitespace-delimited pairs of characters.

Examples

Enigma with rotors I, II, and III, key setting ABC, ring setting DEF, reflector B, and a plugboard connection between ‘P’ and ‘Y’.

use ultra::Enigma;

let mut enigma = Enigma::new("123", "ABC", "DEF", 'B', "PY");

pub fn random() -> Enigma

Creates a new random Enigma with random settings based on thread-local RNG.

Examples

use ultra::Enigma;

let mut enigma_1 = Enigma::random();
let mut enigma_2 = Enigma::random();
assert!(enigma_1.encrypt("ENIGMA") != enigma_2.encrypt("ENIGMA"));

pub fn random_from_u64_seed(seed: u64) -> Enigma

Creates a new random Enigma from a given u64 seed.

Examples

use ultra::Enigma;

let mut enigma_1 = Enigma::random_from_u64_seed(42);
let mut enigma_2 = Enigma::random_from_u64_seed(42);
assert_eq!(enigma_1.encrypt("ENIGMA"), enigma_2.encrypt("ENIGMA"));

pub fn encrypt(&mut self, msg: &str) -> String

Encrypts an entire message, advancing the rotors of the machine after each alphabetic character is encrypted.

Examples

use ultra::Enigma;

let mut enigma = Enigma::new("123", "ABC", "DEF", 'B', "PY");
assert_eq!(enigma.encrypt("ENIGMA"), "HKAJWW");

pub fn reset(&mut self)

Resets the Enigma to its initial state.

Examples

use ultra::Enigma;

let msg = "THIS IS A TEST";

let mut enigma = Enigma::random();
let ciphertext_1 = enigma.encrypt(msg);
let ciphertext_2 = enigma.encrypt(msg);

enigma.reset();

assert_eq!(ciphertext_1, enigma.encrypt(msg));
assert!(ciphertext_1 != ciphertext_2);

pub fn rotor_list(&self) -> String

Returns a string representing the Enigma’s rotor list.

Examples

use ultra::Enigma;

let enigma = Enigma::new("123", "ABC", "DEF", 'B', "PY");
assert_eq!(enigma.rotor_list(), "123");

pub fn key_settings(&self) -> String

Returns a string representing the Enigma’s key settings.

Examples

use ultra::Enigma;

let enigma = Enigma::new("123", "ABC", "DEF", 'B', "PY");
assert_eq!(enigma.key_settings(), "ABC");

pub fn ring_settings(&self) -> String

Returns a string representing the Enigma’s ring settings.

Examples

use ultra::Enigma;

let enigma = Enigma::new("123", "ABC", "DEF", 'B', "PY");
assert_eq!(enigma.ring_settings(), "DEF");

pub fn plugboard(&self) -> String

Returns a string representing the Enigma’s plugboard.

Examples

use ultra::Enigma;

let enigma = Enigma::new("123", "ABC", "DEF", 'B', "PY");
assert_eq!(enigma.plugboard(), "PY");

Trait Implementations

impl Clone for Enigma

fn clone(&self) -> Enigma

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Enigma

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

Formats the value using the given formatter.

impl Display for Enigma

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

Formats the value using the given formatter.