Struct Algorithm 

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

Value object representing a validated algorithm name

This value object encapsulates algorithm names with comprehensive validation to ensure they meet the required format and naming conventions.

Key Features

• Name Validation: Comprehensive validation of algorithm names
• Format Normalization: Normalize names to lowercase
• Character Restrictions: Only alphanumeric, hyphens, and underscores
• Immutability: Algorithm names cannot be changed after creation

Validation Rules

• Must be non-empty after trimming whitespace
• Must contain only alphanumeric characters, hyphens, and underscores
• Is normalized to lowercase for consistency
• Must match the pattern: ^[a-zA-Z0-9_-]+$

Examples

Implementations

impl Algorithm

pub fn new(value: &str) -> Result<Self, PipelineError>

Create a new Algorithm with validation

Purpose

Creates a validated algorithm name with format normalization. Ensures algorithm names follow consistent naming conventions.

Why

Validated algorithm names provide:

• Prevention of configuration errors
• Consistent naming across systems
• Type-safe algorithm specification
• Cross-platform compatibility

Arguments

• value - Algorithm name (alphanumeric, hyphens, underscores)

Returns

• Ok(Algorithm) - Validated algorithm (normalized to lowercase)
• Err(PipelineError) - Invalid format

Errors

• Empty name after trimming
• Invalid characters (only alphanumeric, -, _ allowed)

Examples

pub fn as_str(&self) -> &str

Get the algorithm name as a string

pub fn into_string(self) -> String

Convert to owned String

Trait Implementations

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 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 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 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