Enum DataProfilerError 

pub enum DataProfilerError {
    #[non_exhaustive]
    CsvParsingError {
        message: String,
        suggestion: String,
        source: Option<ErrorSource>,
    },
    FileNotFound {
        path: String,
    },
    UnsupportedFormat {
        format: String,
    },
    #[non_exhaustive]
    InvalidConfiguration {
        message: String,
        suggestion: String,
        source: Option<ErrorSource>,
    },
    InvalidSemanticHint {
        message: String,
        suggestion: String,
    },
    #[non_exhaustive]
    StreamingError {
        message: String,
        suggestion: String,
        source: Option<ErrorSource>,
    },
    #[non_exhaustive]
    IoError {
        message: String,
        source: Option<ErrorSource>,
    },
    EncodingError {
        path: String,
        detail: String,
        guess: String,
    },
    #[non_exhaustive]
    BinaryInput {
        path: String,
        detected: String,
        suggestion: String,
    },
    #[non_exhaustive]
    SourceChanged {
        path: String,
        detail: String,
        suggestion: String,
    },
    #[non_exhaustive]
    JsonParsingError {
        message: String,
        source: Option<ErrorSource>,
    },
    #[non_exhaustive]
    ParquetError {
        message: String,
        source: Option<ErrorSource>,
    },
    #[non_exhaustive]
    ArrowError {
        message: String,
        source: Option<ErrorSource>,
    },
    UnsupportedDataSource {
        message: String,
    },
    AllEnginesFailed {
        message: String,
    },
    MetricsCalculationError {
        message: String,
    },
    DuplicateColumnName {
        names: String,
        plural: String,
        source_label: String,
    },
    ConfigValidationError {
        message: String,
    },
    DatabaseConnectionError {
        message: String,
        suggestion: String,
    },
    DatabaseQueryError {
        message: String,
    },
    DatabaseConfigError {
        message: String,
    },
    DatabaseFeatureDisabled {
        message: String,
    },
    SqlValidationError {
        message: String,
    },
    DatabaseSslError {
        message: String,
    },
}

Enhanced error types with more descriptive messages for DataProfiler

Not Clone: a retained ErrorSource is a boxed trait object, and the originating errors (std::io::Error, csv::Error, …) are not cloneable themselves.

Variants

#[non_exhaustive]

CsvParsingError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

suggestion: String

source: Option<ErrorSource>

FileNotFound

Fields

path: String

UnsupportedFormat

Fields

format: String

#[non_exhaustive]

InvalidConfiguration

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

suggestion: String

source: Option<ErrorSource>

InvalidSemanticHint

Fields

message: String

suggestion: String

#[non_exhaustive]

StreamingError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

suggestion: String

source: Option<ErrorSource>

#[non_exhaustive]

IoError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

source: Option<ErrorSource>

EncodingError

Fields

path: String

detail: String

guess: String

#[non_exhaustive]

BinaryInput

A file whose signature bytes name a binary format (gzip, zstd, zip, Parquet) was about to reach a text reader (#893). Built with DataProfilerError::binary_input.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

path: String

detected: String

What the signature says the file is, e.g. gzip-compressed.

suggestion: String

#[non_exhaustive]

SourceChanged

A remote object changed between the ranged reads of one profile, so the bytes read do not all come from one version of it (#865). Built with DataProfilerError::source_changed.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

path: String

detail: String

What showed the change, e.g. the server answering 412 to If-Match.

suggestion: String

#[non_exhaustive]

JsonParsingError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

source: Option<ErrorSource>

#[non_exhaustive]

ParquetError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

source: Option<ErrorSource>

#[non_exhaustive]

ArrowError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

source: Option<ErrorSource>

UnsupportedDataSource

Fields

message: String

AllEnginesFailed

Fields

message: String

MetricsCalculationError

Fields

message: String

DuplicateColumnName

Fields

names: String

plural: String

source_label: String

ConfigValidationError

Fields

message: String

DatabaseConnectionError

Fields

message: String

suggestion: String

DatabaseQueryError

Fields

message: String

DatabaseConfigError

Fields

message: String

DatabaseFeatureDisabled

Fields

message: String

SqlValidationError

Fields

message: String

DatabaseSslError

Fields

message: String

Implementations

impl DataProfilerError

pub fn database_connection(message: &str) -> Self

Create a database connection error.

The message is scrubbed of URL credentials before storage so a driver error that echoes the connection string cannot leak the password.

pub fn database_query(message: &str) -> Self

Create a database query error.

Redacts URL credentials that a driver error might surface; the raw SQL text and bound parameter values are never embedded by callers.

pub fn database_config(message: &str) -> Self

Create a database config error

pub fn database_feature_disabled(db_name: &str, feature: &str) -> Self

Create a feature-not-enabled error

pub fn sql_validation(message: &str) -> Self

Create a SQL validation error

pub fn database_ssl(message: &str) -> Self

Create a database SSL error

pub fn duplicate_column_name(duplicates: &[String], source: &str) -> Self

Create a duplicate-column-name error from the already-collected list of repeated names and a short transport label.

Only the offending names and the source are embedded — never row values — so the diagnostic cannot leak cell data.

pub fn csv_parsing(original_error: &str, file_path: Option<&str>) -> Self

Create a CSV parsing error with helpful suggestions.

file_path is None at boundaries that do not know the source (e.g. the From<csv::Error> conversion); pass Some(path) whenever it is known so the suggestion can name the offending file instead of a placeholder.

pub fn csv_parsing_from<E>(original: E, file_path: Option<&str>) -> Self

where E: Error + Send + Sync + 'static,

Create a CSV parsing error that retains original as its source.

The suggestion is derived from the same message text as DataProfilerError::csv_parsing, so the two forms render identically; only the cause chain differs.

pub fn file_not_found<P: AsRef<str>>(path: P) -> Self

Create a file not found error with path context

pub fn binary_input(path: &Path, signature: BinarySignature) -> Self

A file at path whose bytes carry signature, refused before a text reader parses it.

pub fn source_changed(path: &str, detail: impl Into<String>) -> Self

The object at path changed while it was being read; detail says how that showed.

pub fn unsupported_format(extension: &str) -> Self

Create unsupported format error with format detection

pub fn invalid_config(message: &str, suggestion: &str) -> Self

Create configuration error with specific suggestion

pub fn invalid_config_with_source<E>( message: impl Into<String>, suggestion: impl Into<String>, original: E, ) -> Self

where E: Error + Send + Sync + 'static,

Create a configuration error that retains original as its source.

Used by the TOML and glob conversions, where the underlying parser reports a position worth reaching programmatically.

pub fn streaming_error(message: &str) -> Self

Create streaming error with context

pub fn streaming_with_suggestion( message: impl Into<String>, suggestion: impl Into<String>, ) -> Self

Create a streaming error with an actionable suggestion and no source.

An empty suggestion means there is no remedy to offer the caller.

pub fn streaming_with_source<E>( message: impl Into<String>, suggestion: impl Into<String>, original: E, ) -> Self

where E: Error + Send + Sync + 'static,

Create a streaming error that retains original without changing its contextual message, suggestion, or streaming category.

pub fn io_error(original: Error) -> Self

Create an I/O error that retains original as its source.

Takes the error by value: std::io::Error is not cloneable, so a borrowed one could only ever be stringified, which is what this issue set out to stop. Use map_err(DataProfilerError::io_error) at call sites.

pub fn io_message(message: &str) -> Self

Create an I/O error from a message, for callers with no originating error to retain (a condition detected by dataprof itself rather than reported by the OS).

pub fn json_parsing_error(original: &str) -> Self

Create a JSON parsing error with no retained source.

pub fn json_parsing_from<E>(original: E) -> Self

where E: Error + Send + Sync + 'static,

Create a JSON parsing error that retains original as its source.

pub fn csv_parsing_with_source<E>( message: impl Into<String>, suggestion: impl Into<String>, original: E, ) -> Self

where E: Error + Send + Sync + 'static,

Create a CSV parsing error with a caller-supplied message and suggestion that still retains original as its source.

For callers whose suggestion is specific to their own context and so cannot come from DataProfilerError::csv_parsing’s message analysis.

pub fn csv_structure( message: impl Into<String>, suggestion: impl Into<String>, ) -> Self

Create a CSV parsing error for a structural problem the parser itself accepted, so there is no underlying error to keep as its source.

pub fn json_parsing_with_source<E>( message: impl Into<String>, original: E, ) -> Self

where E: Error + Send + Sync + 'static,

Create a JSON parsing error with a caller-supplied message that still retains original as its source.

Used where the message adds context the decoder does not have (a record position, a physical line number) and the decoder error is still worth keeping underneath it.

pub fn arrow_with_source<E>(message: impl Into<String>, original: E) -> Self

where E: Error + Send + Sync + 'static,

Create an Arrow error with a caller-supplied message that still retains original as its source.

pub fn parquet_with_source<E>(message: impl Into<String>, original: E) -> Self

where E: Error + Send + Sync + 'static,

Create a Parquet error with a caller-supplied message that still retains original as its source.

pub fn io_with_source<E>(message: impl Into<String>, original: E) -> Self

where E: Error + Send + Sync + 'static,

Create an I/O error with a caller-supplied message that still retains original as its source.

pub fn arrow_error(message: &str) -> Self

Create an Arrow error with no retained source.

pub fn arrow_error_from<E>(original: E) -> Self

where E: Error + Send + Sync + 'static,

Create an Arrow error that retains original as its source.

pub fn parquet_error(message: &str) -> Self

Create a Parquet error with no retained source.

pub fn suggestion(&self) -> Option<String>

The actionable next step for this error, as structured context.

Suggestions live in the variants and the Display string, but callers that want to react programmatically (or render the hint separately from the message) should read it here rather than parse the formatted output.

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

Get error category for logging/metrics

Trait Implementations

impl Debug for DataProfilerError

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

Formats the value using the given formatter.

impl Display for DataProfilerError

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

Formats the value using the given formatter.

impl Error for DataProfilerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for DataProfilerError

Convert from anyhow::Error to DataProfilerError with context.

These conversions run where the source path/operation is not known, so they never fabricate one: a path is only ever attached by the call sites that hold it (see DataProfilerError::csv_parsing, map_io_error, and the facade’s existence check). Preserving the original message keeps the source diagnostic.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DataProfilerError

Convert from std::io::Error to DataProfilerError.

Path-less by design: callers that know the file use map_io_error to produce a DataProfilerError::FileNotFound with the real path. Here we keep the OS message (which already names the condition) rather than guessing a path.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DataProfilerError

Convert from csv::Error to DataProfilerError with enhanced context.

The source path is unknown at this boundary, so the suggestion is written without a filename rather than the misleading 'unknown' placeholder.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DataProfilerError

Convert from serde_json::Error to DataProfilerError

fn from(err: Error) -> Self

Converts to this type from the input type.