Struct DataFusionErrorBuilder

pub struct DataFusionErrorBuilder(/* private fields */);

A builder for DataFusionError

This builder can be used to collect multiple errors and return them as a DataFusionError::Collection.

Example: no errors

let mut builder = DataFusionError::builder();
// ok_or returns the value if no errors have been added
assert_eq!(builder.error_or(42).unwrap(), 42);

Example: with errors

let mut builder = DataFusionError::builder();
builder.add_error(DataFusionError::Internal("foo".to_owned()));
// ok_or returns the value if no errors have been added
assert_contains!(builder.error_or(42).unwrap_err().to_string(), "Internal error: foo");

Implementations

impl DataFusionErrorBuilder

pub fn new() -> Self

Create a new DataFusionErrorBuilder

pub fn add_error(&mut self, error: DataFusionError)

Add an error to the in progress list

Example

let mut builder = DataFusionError::builder();
builder.add_error(DataFusionError::Internal("foo".to_owned()));
assert_contains!(builder.error_or(42).unwrap_err().to_string(), "Internal error: foo");

pub fn with_error(self, error: DataFusionError) -> Self

Add an error to the in progress list, returning the builder

Example

let builder = DataFusionError::builder()
  .with_error(DataFusionError::Internal("foo".to_owned()));
assert_contains!(builder.error_or(42).unwrap_err().to_string(), "Internal error: foo");

pub fn error_or<T>(self, ok: T) -> Result<T, DataFusionError>

Returns Ok(ok) if no errors were added to the builder, otherwise returns a Result::Err

Trait Implementations

impl Debug for DataFusionErrorBuilder

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

Formats the value using the given formatter.

impl Default for DataFusionErrorBuilder

fn default() -> DataFusionErrorBuilder

Returns the “default value” for a type.