rotorix-core 0.1.0

Enigma-inspired transformation pipeline with explicit state and pluggable components
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Error types for the rotorix-core crate.

use std::fmt;

/// Result type used throughout the rotorix-core crate.
pub type EnigmaResult<T> = Result<T, EnigmaError>;

/// Errors that can occur while building or running an Enigma machine.
#[derive(Debug)]
pub enum EnigmaError {
    /// The machine configuration is invalid.
    InvalidConfiguration(String),

    /// The provided state is incompatible with the machine.
    InvalidState(String),

    /// A component failed to process input.
    ComponentError(String),

    /// A stepping strategy failed.
    SteppingError(String),
}

impl fmt::Display for EnigmaError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            EnigmaError::InvalidConfiguration(msg) => {
                write!(f, "invalid configuration: {msg}")
            }
            EnigmaError::InvalidState(msg) => {
                write!(f, "invalid state: {msg}")
            }
            EnigmaError::ComponentError(msg) => {
                write!(f, "component error: {msg}")
            }
            EnigmaError::SteppingError(msg) => {
                write!(f, "stepping error: {msg}")
            }
        }
    }
}

impl std::error::Error for EnigmaError {}