Skip to main content

SemanticHints

Struct SemanticHints 

Source
#[non_exhaustive]
pub struct SemanticHints { pub positive_columns: Vec<String>, pub identifier_columns: Vec<String>, pub temporal_columns: Vec<String>, }
Expand description

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

Fields (Non-exhaustive)§

This struct is marked as 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>

Implementations§

Source§

impl SemanticHints

Source

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

Source

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

Source

pub fn is_empty(&self) -> bool

Source

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

Source

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

Source

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

Source

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

Every (kind, column_name) pair across all three hint lists.

Source

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.

Source

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.

Source

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§

Source§

impl Clone for SemanticHints

Source§

fn clone(&self) -> SemanticHints

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SemanticHints

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SemanticHints

Source§

fn default() -> SemanticHints

Returns the “default value” for a type. Read more
Source§

impl Eq for SemanticHints

Source§

impl PartialEq for SemanticHints

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SemanticHints

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V