Struct Wheel

pub struct Wheel<const ROTOR_NUM: usize = DEFAULT_ROTOR_NUM> { /* private fields */ }

Represents the configuration (i.e. ordering) of the Rotor set in an Enigma machine

Implementations

impl<const ROTOR_NUM: usize> Wheel<ROTOR_NUM>

pub fn new(rotors: [Rotor; ROTOR_NUM]) -> Self

Creates a new Rotor configuration in left-to-right ordering

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

Send a signal forward through the rotors

pub fn step(&mut self)

Step the rotors

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

Send a signal backward through the rotors

pub fn set_positions(&mut self, positions: [Letter; ROTOR_NUM])

Set the positions of each Rotor in left-to-right ordering

pub fn set_ring_wiring_offset(&mut self, positions: [u8; ROTOR_NUM])

Set the wiring offset (aka ring setting) of each Rotor in left-to-right ordering

pub fn get_positions(&self) -> [Letter; ROTOR_NUM]

Get current Rotor positions

Trait Implementations

impl<const ROTOR_NUM: usize> Clone for Wheel<ROTOR_NUM>

fn clone(&self) -> Wheel<ROTOR_NUM>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const ROTOR_NUM: usize> Debug for Wheel<ROTOR_NUM>

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

Formats the value using the given formatter.

impl<const ROTOR_NUM: usize> Default for Wheel<ROTOR_NUM>

fn default() -> Self

Returns the “default value” for a type.

impl<const ROTOR_NUM: usize> Hash for Wheel<ROTOR_NUM>

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<const ROTOR_NUM: usize> Ord for Wheel<ROTOR_NUM>

fn cmp(&self, other: &Wheel<ROTOR_NUM>) -> 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<const ROTOR_NUM: usize> PartialEq for Wheel<ROTOR_NUM>

fn eq(&self, other: &Wheel<ROTOR_NUM>) -> 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<const ROTOR_NUM: usize> PartialOrd for Wheel<ROTOR_NUM>

fn partial_cmp(&self, other: &Wheel<ROTOR_NUM>) -> 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<const ROTOR_NUM: usize> Copy for Wheel<ROTOR_NUM>

impl<const ROTOR_NUM: usize> Eq for Wheel<ROTOR_NUM>

impl<const ROTOR_NUM: usize> StructuralPartialEq for Wheel<ROTOR_NUM>