Struct SemanticHints 

#[non_exhaustive]
pub struct SemanticHints {
    pub positive_columns: Vec<String>,
    pub identifier_columns: Vec<String>,
    pub temporal_columns: Vec<String>,
    pub temporal_pairs: Vec<(String, String)>,
}

User-supplied semantic hints that affect profiling and quality metrics.

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.

positive_columns: Vec<String>

identifier_columns: Vec<String>

temporal_columns: Vec<String>

temporal_pairs: Vec<(String, String)>

Start/end column pairs declared by the caller, compared as given.

Implementations

impl SemanticHints

pub fn new( positive_columns: Vec<String>, identifier_columns: Vec<String>, ) -> SemanticHints

pub fn with_temporal_columns( self, temporal_columns: Vec<String>, ) -> SemanticHints

pub fn with_temporal_pairs( self, temporal_pairs: Vec<(String, String)>, ) -> SemanticHints

Declare start/end column pairs for timeliness to compare as given, such as valid_from/valid_until, which no role word pairs by name.

pub fn is_empty(&self) -> bool

pub fn is_identifier_column(&self, column_name: &str) -> bool

pub fn is_positive_column(&self, column_name: &str) -> bool

pub fn is_temporal_column(&self, column_name: &str) -> bool

pub fn temporal_pair_columns(&self) -> Vec<&str>

Each column named by a declared pair, once, in the order first named.

pub fn iter(&self) -> impl Iterator<Item = (SemanticHintKind, &str)>

Every (kind, column_name) pair once, preserving the first occurrence within each hint list. A column may still carry different hint kinds.

pub fn validate_names( &self, column_names: &[&str], ) -> Result<(), DataProfilerError>

Fail loudly when a hint names a column that is not in the schema.

A hint is the user’s chosen alternative to overconfident inference, so a hint that cannot bind must not vanish: a typo’d or stale column name is a mistake the profiler should surface, not silently discard.

pub fn validate_quality_usage( &self, quality_computed: bool, ) -> Result<(), DataProfilerError>

Reject value-driven hints when the Quality metric pack did not run.

Positive and temporal hints only affect quality calculators. Accepting them without a quality assessment would make the configuration look effective while producing neither metrics nor binding evidence.

pub fn validate_bindings( &self, bindings: &[SemanticHintBinding], ) -> Result<(), DataProfilerError>

Fail loudly when a hint names a real column but bound to nothing.

Only bindings that were assessed over the full data (SemanticHintBinding::is_proven_inert) raise; sampled evidence is carried in the report but never treated as proof of absence.

Trait Implementations

impl Clone for SemanticHints

fn clone(&self) -> SemanticHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SemanticHints

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

Formats the value using the given formatter.

impl Default for SemanticHints

fn default() -> SemanticHints

Returns the “default value” for a type.

impl Eq for SemanticHints

impl PartialEq for SemanticHints

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SemanticHints