Struct Algorithm 

pub struct Algorithm(/* private fields */);

Algorithm value object for pipeline stage processing

Purpose

Type-safe algorithm specification that provides:

• Validation of algorithm names and formats
• Algorithm-specific behavior and constraints
• Immutable value semantics (DDD value object)
• Cross-language compatibility

Supported Algorithms

• Compression: brotli, gzip, zstd, lz4
• Encryption: aes-256-gcm, chacha20-poly1305, aes-128-gcm
• Hashing: sha256, sha512, blake3
• Custom: User-defined algorithms

Cross-Language Mapping

• Rust: Algorithm (newtype wrapper)
• Go: Algorithm struct with same interface
• JSON: String representation
• SQLite: TEXT column with validation

Examples

Implementations

impl Algorithm

pub fn new(name: String) -> Result<Self, PipelineError>

Creates a new algorithm with validated name

Purpose

Creates an Algorithm value object after validating the algorithm name against strict format rules. This ensures all algorithm instances are valid and type-safe. # Why Algorithm names must follow a consistent format for:

• Cross-language compatibility (Rust, Go, JSON)
• Database storage validation
• Configuration file parsing
• Prevention of injection attacks

Arguments

• name - The algorithm name string. Must:
  • Not be empty
  • Be 1-64 characters long
  • Contain only lowercase letters, hyphens, and digits
  • Not start with a hyphen or digit
  • Not end with a hyphen
  • Not contain consecutive hyphens

Returns

• Ok(Algorithm) - Successfully validated algorithm
• Err(PipelineError::InvalidConfiguration) - Name validation failed

Errors

Returns PipelineError::InvalidConfiguration when:

• Name is empty
• Name exceeds 64 characters
• Name contains invalid characters (uppercase, special chars)
• Name starts/ends with hyphen
• Name starts with digit
• Name contains consecutive hyphens (“–”)

Examples

pub fn parse(name: &str) -> Result<Self, PipelineError>

Creates an algorithm from a string slice

Purpose

Convenience constructor that accepts a string slice instead of an owned String. Internally converts to String and delegates to new().

Arguments

• name - String slice containing the algorithm name

Returns

• Ok(Algorithm) - Successfully validated algorithm
• Err(PipelineError::InvalidConfiguration) - Name validation failed

Errors

See Algorithm::new for validation rules and error conditions.

Examples

pub fn name(&self) -> &str

Gets the algorithm name as a string reference

Purpose

Provides read-only access to the algorithm’s underlying name string.

Returns

String slice containing the algorithm name

Examples

pub fn is_compression(&self) -> bool

Checks if this is a compression algorithm

Purpose

Determines whether the algorithm belongs to the compression category. Used for algorithm validation and compatibility checks.

Why

Compression algorithms require specific stage configurations and have different performance characteristics than encryption or hashing algorithms. # Returns

• true - Algorithm is one of: brotli, gzip, zstd, lz4, deflate
• false - Algorithm is not a compression algorithm

Examples

pub fn is_encryption(&self) -> bool

Checks if this is an encryption algorithm

Purpose

Determines whether the algorithm belongs to the encryption category. Used for security validation and stage compatibility checks.

Why

Encryption algorithms require key management and have different security properties than compression or hashing algorithms.

Returns

• true - Algorithm is one of: aes-256-gcm, aes-128-gcm, aes-128-cbc, chacha20-poly1305, aes-256-cbc
• false - Algorithm is not an encryption algorithm

Examples

pub fn is_hashing(&self) -> bool

Checks if this is a hashing algorithm

Purpose

Determines whether the algorithm belongs to the hashing category. Used for integrity validation and stage compatibility checks.

Why

Hashing algorithms are one-way functions used for integrity verification, with different properties than compression or encryption algorithms. # Returns

• true - Algorithm is one of: sha256, sha512, sha3-256, blake3, md5, sha1
• false - Algorithm is not a hashing algorithm

Note

MD5 and SHA1 are included for backward compatibility but are not recommended for security-critical applications.

Examples

pub fn is_custom(&self) -> bool

Checks if this is a custom algorithm

Purpose

Determines whether the algorithm is a custom (user-defined) algorithm that doesn’t match any of the predefined categories.

Why

Custom algorithms allow extensibility for domain-specific processing while maintaining type safety and validation.

Returns

• true - Algorithm starts with “custom-” prefix OR doesn’t match any predefined compression, encryption, or hashing algorithm
• false - Algorithm is a predefined standard algorithm

Examples

pub fn category(&self) -> AlgorithmCategory

Gets the algorithm category

Purpose

Classifies the algorithm into one of the predefined categories. Used for compatibility validation and processing stage selection.

Returns

One of:

• AlgorithmCategory::Compression - For compression algorithms
• AlgorithmCategory::Encryption - For encryption algorithms
• AlgorithmCategory::Hashing - For hashing algorithms
• AlgorithmCategory::Custom - For custom/unknown algorithms

Examples

pub fn validate(&self) -> Result<(), PipelineError>

Validates the algorithm

Purpose

Re-validates the algorithm name format. Useful for ensuring algorithm integrity after deserialization or when working with external data.

Why

While algorithms are validated on creation, this method allows revalidation after deserialization or when algorithm constraints change. # Returns

• Ok(()) - Algorithm name is valid
• Err(PipelineError::InvalidConfiguration) - Name validation failed

Errors

See Algorithm::new for validation rules and error conditions.

Examples

impl Algorithm

Predefined algorithms for common use cases

pub fn brotli() -> Self

Creates a Brotli compression algorithm

Purpose

Factory method for the Brotli compression algorithm. Brotli offers excellent compression ratios with good performance.

Returns

Validated Algorithm instance for Brotli

Examples

pub fn gzip() -> Self

Creates a Gzip compression algorithm

Purpose

Factory method for the Gzip compression algorithm. Widely supported compression with balanced performance.

Returns

Validated Algorithm instance for Gzip

Examples

pub fn zstd() -> Self

Creates a Zstandard compression algorithm

Purpose

Factory method for the Zstandard compression algorithm. Excellent balance of compression ratio and speed.

Returns

Validated Algorithm instance for Zstandard

Examples

pub fn lz4() -> Self

Creates an LZ4 compression algorithm

Purpose

Factory method for the LZ4 compression algorithm. Extremely fast compression with moderate compression ratios.

Returns

Validated Algorithm instance for LZ4

Examples

pub fn aes_256_gcm() -> Self

Creates an AES-256-GCM encryption algorithm

Purpose

Factory method for AES-256 with Galois/Counter Mode. Provides authenticated encryption with strong security.

Returns

Validated Algorithm instance for AES-256-GCM

Examples

pub fn chacha20_poly1305() -> Self

Creates a ChaCha20-Poly1305 encryption algorithm

Purpose

Factory method for ChaCha20 stream cipher with Poly1305 MAC. Modern authenticated encryption with excellent performance on mobile/embedded. # Returns Validated Algorithm instance for ChaCha20-Poly1305

Examples

pub fn sha256() -> Self

Creates a SHA-256 hashing algorithm

Purpose

Factory method for SHA-256 cryptographic hash function. Industry-standard hashing for integrity verification.

Returns

Validated Algorithm instance for SHA-256

Examples

pub fn sha512() -> Self

Creates a SHA-512 hashing algorithm

Purpose

Factory method for SHA-512 cryptographic hash function. Stronger variant of SHA-2 family with 512-bit output.

Returns

Validated Algorithm instance for SHA-512

Examples

pub fn blake3() -> Self

Creates a BLAKE3 hashing algorithm

Purpose

Factory method for BLAKE3 cryptographic hash function. Modern, high-performance hashing with strong security properties.

Returns

Validated Algorithm instance for BLAKE3

Examples

pub fn aes256_gcm() -> Self

AES-256-GCM encryption algorithm (alias for test framework compatibility)

pub fn none() -> Self

No algorithm / passthrough

pub fn aes_128_cbc() -> Self

AES-128-CBC encryption

pub fn sha3_256() -> Self

SHA3-256 hashing

Trait Implementations

impl AsRef<str> for Algorithm

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Algorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl From<Algorithm> for String

fn from(algorithm: Algorithm) -> Self

Converts to this type from the input type.

impl FromStr for Algorithm

type Err = PipelineError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Algorithm

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 Algorithm

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm