Skip to main content

AnalysisOptions

Struct AnalysisOptions 

Source
pub struct AnalysisOptions { /* private fields */ }
Expand description

What to analyze, and how, for a single profiling run.

Construct with AnalysisOptions::default (analyze everything) and narrow with the builder methods.

Implementations§

Source§

impl AnalysisOptions

Source

pub fn with_columns(self, columns: Option<Vec<String>>) -> Self

Select top-level columns to profile. None (the default) means every column.

Selection is by name and reports remain in source-schema order. An empty vector requests a schema with no profiled columns.

Source

pub fn with_metric_packs(self, packs: Option<Vec<MetricPack>>) -> Self

Select the metric packs to compute. None (the default) means all.

Source

pub fn with_quality_dimensions( self, dimensions: Option<Vec<QualityDimension>>, ) -> Self

Select the quality dimensions to assess. None (the default) means all.

Source

pub fn with_locale(self, locale: Option<Locale>) -> Self

Set the locale used to rank detected patterns.

Parse a user-supplied tag with Locale::parse_optional first, so an unrecognised tag is rejected where it is written rather than silently suppressing every locale-specific pattern.

Source

pub fn with_semantic_hints(self, hints: SemanticHints) -> Self

Set the user’s semantic hints.

Source

pub fn with_reference_date(self, reference_date: Option<NaiveDate>) -> Self

Fix the date timeliness measures against. None (the default) reads today’s UTC date when the run starts, so an unchanged file’s timeliness moves as the calendar does; a fixed date makes it reproducible (#903). The report records which one the score used.

Source

pub fn with_duplicate_rows_exact_limit(self, limit: Option<usize>) -> Self

Count duplicate rows exactly up to limit distinct rows (#1292).

None (the default) keeps the built-in limit of one million distinct rows, past which the count is an estimate and the memory budget may end the exact count earlier. A limit set here is a row count, so the verdict does not depend on the machine: the row tracker keeps its exact set up to the limit whatever memory_limit_mb says, at 10 to 20 bytes per distinct row, and that set is not counted against the budget.

Source

pub fn effective_metric_packs(&self) -> Option<Vec<MetricPack>>

The packs to compute, with an empty quality-dimension selection folded in.

Resolved on read rather than in the setters so the outcome does not depend on the order the selections were made in.

Source

pub fn selected_metric_packs(&self) -> Vec<MetricPack>

Every pack the run computes, in MetricPack::all order: the effective selection with the schema pack, which is always computed, made explicit. Two requests that compute the same packs return the same list, whatever order or repetition they were given in.

Source

pub fn include_statistics(&self) -> bool

Whether per-column statistics should be computed.

Source

pub fn include_patterns(&self) -> bool

Whether pattern detection should run.

Source

pub fn include_quality(&self) -> bool

Whether quality metrics should be computed.

false means the report carries no quality at all — absent, not an empty assessment — because nothing was analyzed.

Source

pub fn locale(&self) -> Option<Locale>

The locale used to rank detected patterns.

A locale only ranks patterns, so it has no effect of its own when include_patterns is false and detection never runs.

Source

pub fn reference_date(&self) -> Option<NaiveDate>

The fixed timeliness reference date, or None to read today’s.

Source

pub fn duplicate_rows_exact_limit(&self) -> Option<usize>

The duplicate-row exact limit the caller set, or None for the default.

Source

pub fn quality_dimensions(&self) -> Option<&[QualityDimension]>

The requested quality dimensions, if the caller narrowed them.

Source

pub fn semantic_hints(&self) -> &SemanticHints

The user’s semantic hints.

Source

pub fn columns(&self) -> Option<&[String]>

The requested top-level column names, or None when every column is selected.

Source

pub fn has_column_projection(&self) -> bool

Whether the caller selected a subset of the source columns.

Source

pub fn column_indices( &self, available: &[String], ) -> Result<Option<Vec<usize>>, DataProfilerError>

Resolve the selected columns against a source schema.

Returned indices follow source order, not request order, so every input path preserves the same stable report ordering. Unknown and duplicate requests fail rather than producing a plausible partial profile.

Trait Implementations§

Source§

impl Clone for AnalysisOptions

Source§

fn clone(&self) -> Self

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 AnalysisOptions

Source§

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

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

impl Default for AnalysisOptions

Source§

fn default() -> Self

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

impl Eq for AnalysisOptions

Source§

impl PartialEq for AnalysisOptions

Source§

fn eq(&self, other: &Self) -> 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 AnalysisOptions

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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