Struct mini_enigma::state_machine::Enigma

pub struct Enigma<R, P, O> { /* private fields */ }

Enigma Finite State Machine

An incomplete instance (e.g. from Enigma::default) can be initialised later semi-dynamically with the compiler checking correct initialisation before use.

Examples

let enigma = Enigma::default()
    .set_rotors(Wheel::new([ROTOR_I, ROTOR_II, ROTOR_III]))
    .set_plugboard(Plugboard::new(&[]));

let mut enigma = enigma.set_reflector(REFLECTOR_A);

enigma.encrypt_letter(Letter::A);

The compiler can detect if one of the required initialisation steps is missing:

let mut enigma = Enigma::default()
    .set_rotors(Wheel::new([ROTOR_I, ROTOR_II, ROTOR_III]))
    .set_plugboard(Plugboard::new(&[]));

enigma.encrypt_letter(Letter::A); // encrypt can't be called until a reflector is set

Implementations

impl Enigma<Unset, Unset, Unset>

pub fn new(config: &EnigmaSettings) -> Enigma<Wheel, Plugboard, Reflector>

Create a fully setup Enigma FSM from the provided settings

Examples

let mut enigma = Enigma::new(&EnigmaSettings {
    rotors: [ROTOR_II, ROTOR_IV, ROTOR_V],
    plugboard: Plugboard::from_str(
        "AV,BS,CG,DL,FU,HZ,IN,KM,OW,RX",
    ).unwrap(),
    reflector: REFLECTOR_B,
    ringstellung: [2, 21, 12],
    grundstellung: [Letter::B, Letter::L, Letter::A],
});
enigma.encrypt_letter(Letter::A);

impl<AnyRotor, AnyPlugboard, AnyReflector> Enigma<AnyRotor, AnyPlugboard, AnyReflector>

pub fn set_rotors( self, rotors: Wheel ) -> Enigma<Wheel, AnyPlugboard, AnyReflector>

Set the Enigma rotors

pub fn set_plugboard( self, plugboard: Plugboard ) -> Enigma<AnyRotor, Plugboard, AnyReflector>

Set the Enigma plguboard

pub fn set_reflector( self, reflector: Reflector ) -> Enigma<AnyRotor, AnyPlugboard, Reflector>

Set the Enigma reflector

impl<AnyPlugboard, AnyReflector> Enigma<Wheel, AnyPlugboard, AnyReflector>

pub fn set_grundstellung( &mut self, positions: [Letter; 3] ) -> &mut Enigma<Wheel, AnyPlugboard, AnyReflector>

Set the starting position for the rotors

pub fn set_ringstellung( &mut self, positions: [u8; 3] ) -> &mut Enigma<Wheel, AnyPlugboard, AnyReflector>

Set the ring settings for the rotors

pub fn get_grundstellung(&self) -> [Letter; 3]

Get Rotor positions

impl Enigma<Wheel, Plugboard, Reflector>

pub fn encrypt_letter(&mut self, letter: Letter) -> Letter

Encrypt/decrypt a Letter and advance the state

pub fn encrypt_char(&mut self, letter: char) -> char

Encrypt/decrypt a char and advance the state

Trait Implementations

impl<R: Clone, P: Clone, O: Clone> Clone for Enigma<R, P, O>

fn clone(&self) -> Enigma<R, P, O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug, P: Debug, O: Debug> Debug for Enigma<R, P, O>

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

Formats the value using the given formatter.

impl Default for Enigma<Unset, Unset, Unset>

fn default() -> Self

Returns the “default value” for a type.

impl<R: Hash, P: Hash, O: Hash> Hash for Enigma<R, P, O>

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<R: Ord, P: Ord, O: Ord> Ord for Enigma<R, P, O>

fn cmp(&self, other: &Enigma<R, P, O>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<R: PartialEq, P: PartialEq, O: PartialEq> PartialEq for Enigma<R, P, O>

fn eq(&self, other: &Enigma<R, P, O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<R: PartialOrd, P: PartialOrd, O: PartialOrd> PartialOrd for Enigma<R, P, O>

fn partial_cmp(&self, other: &Enigma<R, P, O>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<R: Copy, P: Copy, O: Copy> Copy for Enigma<R, P, O>

impl<R: Eq, P: Eq, O: Eq> Eq for Enigma<R, P, O>

impl<R, P, O> StructuralPartialEq for Enigma<R, P, O>