Struct DetectionCandidate 

#[non_exhaustive]
pub struct DetectionCandidate {
    pub field: String,
    pub cardinality: usize,
}

One candidate field surfaced when auto-detection cannot pick a grouping field on its own.

Listed inside FaceError::AmbiguousDetection so callers can render the §11.2 hint message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field: String

Field path (e.g. data.path.text).

cardinality: usize

Number of distinct values observed for this field.

Implementations

impl DetectionCandidate

pub fn new(field: impl Into<String>, cardinality: usize) -> Self

Construct a candidate from a field path and an observed distinct-value count.

DetectionCandidate is #[non_exhaustive]; downstream crates (notably face-cli) build the candidate list when the CLI falls back into FaceError::AmbiguousDetection, so this constructor is the intended public entry point.

Examples

use face_core::DetectionCandidate;

let c = DetectionCandidate::new("data.path.text", 47);
assert_eq!(c.field, "data.path.text");
assert_eq!(c.cardinality, 47);

Trait Implementations

impl Clone for DetectionCandidate

fn clone(&self) -> DetectionCandidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetectionCandidate

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

Formats the value using the given formatter.