hyperevolution 0.2.0

Exact-aware evolutionary and proposal-search carriers for the Hyper ecosystem
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

//! Stable search identifiers.

/// Error returned by id constructors.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum EvolutionError {
    /// A stable id was empty.
    EmptyIdentifier,
}

/// Result alias used by `hyperevolution`.
pub type EvolutionResult<T> = Result<T, EvolutionError>;

/// Stable candidate identifier.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct CandidateId(String);

impl CandidateId {
    /// Creates a non-empty candidate id.
    pub fn new(value: impl Into<String>) -> EvolutionResult<Self> {
        let value = value.into();
        if value.is_empty() {
            return Err(EvolutionError::EmptyIdentifier);
        }
        Ok(Self(value))
    }

    /// Returns the id text.
    pub fn as_str(&self) -> &str {
        &self.0
    }
}