Struct Rotor

pub struct Rotor { /* private fields */ }

The Engima Rotor or Walzen

Implementations

impl Rotor

pub const fn from_static_str( string: &'static str, notches: [Letter; 2], fixed: bool, ) -> Rotor

Create a Rotor from a string

If the Rotor has a single notch then the notches array should be set to that value for all elements

pub fn set_grundstellung(&mut self, letter: Letter)

Set the rotors initial positions

pub fn set_ringstellung(&mut self, ringstellung: u8)

Set the rotors ring settings

Panics

ringstellung is 0 or lower

pub fn wiring_map(&self, index: Letter) -> Letter

Send a signal to the right side of the rotor at position index and return the position the signal exits the rotor

pub fn rev_wiring_map(&self, index: Letter) -> Letter

Send a signal to the left side of the rotor at position index and return the position the signal exits the rotor

pub fn step(&mut self) -> bool

Step the rotor and return whether to turnover the next rotor

pub fn get_grundstellung(&self) -> Letter

Get current position

pub fn will_turn(&self) -> bool

Returns whether the rotor will cause a turnover on the next step

Required for doublestepping

Trait Implementations

impl Clone for Rotor

fn clone(&self) -> Rotor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rotor

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

Formats the value using the given formatter.

impl Default for Rotor

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Rotor

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 Rotor

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

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

fn partial_cmp(&self, other: &Rotor) -> 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 Copy for Rotor

impl Eq for Rotor

impl StructuralPartialEq for Rotor