Struct Error 

pub struct Error { /* private fields */ }

Structured adapter error with stable classification and facts.

fmt::Display renders only the human-facing Self::message. Machine policy must use the typed accessors (code, kind, status, operation, fact lookups, find_algeon_error), never parsed text. fmt::Debug renders diagnostic text containing only log-safe facts and omits the underlying causal chain.

Implementations

impl Error

pub fn new( code: ErrorCode, operation: &'static str, message: impl Into<String>, ) -> Self

Creates an adapter error with a stable operation id and message.

operation should be a stable dotted identifier such as algeon_datafusion.native_exec.execute. message is human-facing diagnostic text. Add machine-readable context with Self::with_fact.

pub fn with_fact(self, key: &'static str, value: impl ToString) -> Self

Adds one machine-readable fact.

key must be a non-empty static string and should be treated as part of the diagnostic contract once exposed. value is stringified with ToString. Empty keys are ignored. Duplicate keys preserve the first value and are recorded under fact_collision_keys. Facts added here remain raw and are hidden from logs, retained diagnostics, and Facts’s fmt::Debug output unless the caller instead makes the explicit Self::with_log_safe_fact disclosure choice.

pub fn with_log_safe_fact(self, key: &'static str, value: impl ToString) -> Self

Adds a fact that may be projected into logs and retained diagnostics.

Opts a fact into log and diagnostic projection under the disclosure policy. This method differs from Self::with_fact by permitting external visibility, and callers must restrict usage to bounded operational classifications that omit credentials, identifiers, paths, query literals, and sensitive payloads. Projections apply defensive redaction for URI and credential-like tokens alongside size limits, but sanitization does not replace careful classification. External or arbitrary facts must use Self::with_fact to remain hidden by default.

Caller schema details (for example strict-rejection column names) are a ClientDetail, never log-safe facts. The reserved error_facts_truncated key remains available through raw typed lookup, but cannot be opted into the projection; only the projection itself may emit that retained marker. Empty and duplicate keys follow Self::with_fact’s first-write collision policy.

pub fn with_client_detail(self, detail: ClientDetail) -> Self

Attaches the caller schema detail this error names, when none is attached yet.

pub fn with_preserved_facts(self, facts: Facts) -> Self

Replaces this error’s fact set with an existing set, preserving its disclosure flags and collision evidence.

pub fn with_source<E>(self, source: E) -> Self

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

Attaches the source error when no source is already present.

A second source is discarded so error decoration cannot replace the original causal chain.

pub fn with_boxed_source( self, source: Box<dyn StdError + Send + Sync + 'static>, ) -> Self

Attaches an already boxed source error when no source is already present.

A second source is discarded so error decoration cannot replace the original causal chain.

pub fn from_cudf( operation: &'static str, message: impl Into<String>, source: Error, ) -> Self

Wraps a cudf::Error at the adapter boundary.

operation should be the stable dotted id for the adapter operation that called cuDF, and message should describe the failure for humans. cuDF classification and a URI-redacted message are preserved as cudf_* facts.

pub fn code(&self) -> ErrorCode

Returns the stable machine-readable adapter error code.

pub fn kind(&self) -> ErrorKind

Returns the coarse category derived from Self::code.

pub fn status(&self) -> ErrorStatus

Returns the retry/remediation status derived from Self::code.

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

Returns the stable dotted operation id that produced the error.

pub fn message(&self) -> &str

Returns the human-facing diagnostic message.

pub fn facts(&self) -> &Facts

Returns the sorted machine-readable fact set.

pub fn fact_value(&self, key: &str) -> Option<&str>

Returns one fact value by key.

pub fn client_detail(&self) -> Option<&ClientDetail>

Caller schema detail this error names.

pub fn source_error(&self) -> Option<&(dyn StdError + 'static)>

Returns the underlying source error when one was attached.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn StdError + '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 DataFusionError

fn from(error: Error) -> Self

Converts to this type from the input type.