Enum Preset 

#[non_exhaustive]
pub enum Preset {
    Confidence,
    ConceptSearch,
    Bm25,
    Severity,
}

One of the auto-detected presets per §4.4.

--preset=NAME from the CLI bypasses detection and selects one of these directly; matching on Preset::from_name is case-insensitive.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Confidence

Max ≤ 1.0, all values in [0, 1].

ConceptSearch

Max ≈ 1000 (within ±10%), no negatives.

Bm25

Long-tail, no upper bound, max far above p99.

Severity

Skewed, all small non-negative integers (treated as ordinal).

Implementations

impl Preset

pub fn name(&self) -> &'static str

Kebab-case name used on the CLI and in envelope provenance.

Examples

use face_core::detect::Preset;

assert_eq!(Preset::ConceptSearch.name(), "concept-search");

pub fn from_name(name: &str) -> Option<Preset>

Parse the kebab-case name supplied by --preset=. Case-insensitive. Returns None for unknown names — the CLI wraps that in crate::FaceError::ConflictingFlags (or similar) at the call site.

Examples

use face_core::detect::Preset;

assert_eq!(Preset::from_name("BM25"), Some(Preset::Bm25));
assert_eq!(Preset::from_name("nope"), None);

Trait Implementations

impl Clone for Preset

fn clone(&self) -> Preset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Preset

impl Debug for Preset

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

Formats the value using the given formatter.

impl Eq for Preset

impl Hash for Preset

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 Preset

fn eq(&self, other: &Preset) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Preset