Struct ErrorBuilder 

pub struct ErrorBuilder { /* private fields */ }

Builder for constructing errors with rich context

This builder enables fluent, ergonomic error construction with additional context.

Examples

use oxigdal_core::error::OxiGdalError;
use std::path::Path;

let err = OxiGdalError::io_error_builder("Cannot read file")
    .with_path(Path::new("/data/file.tif"))
    .with_operation("read_raster")
    .with_suggestion("Check file permissions")
    .build();

Implementations

impl ErrorBuilder

pub fn new(error: OxiGdalError) -> Self

Create a new error builder

pub fn with_path(self, path: impl AsRef<Path>) -> Self

Set the file path associated with this error

pub fn with_operation(self, operation: impl Into<String>) -> Self

Set the operation name that failed

pub fn with_parameter( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a parameter key-value pair

pub fn with_suggestion(self, suggestion: impl Into<String>) -> Self

Set a custom suggestion (overrides the default suggestion)

pub fn build(self) -> OxiGdalError

Build the final error, incorporating all context

Note: The additional context is stored and can be retrieved via the error’s context() method after building.

pub fn into_error(self) -> OxiGdalError

Get the error without building (consumes self)

pub fn error(&self) -> &OxiGdalError

Get a reference to the underlying error

pub fn file_path(&self) -> Option<&Path>

Get the file path (if set)

pub fn operation_name(&self) -> Option<&str>

Get the operation name (if set)

pub fn parameters(&self) -> &HashMap<String, String>

Get the parameters

pub fn custom_suggestion(&self) -> Option<&str>

Get the custom suggestion (if set)

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

Get the effective suggestion (custom or default)

pub fn build_context(&self) -> ErrorContext

Build an enriched error context

Trait Implementations

impl Debug for ErrorBuilder

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

Formats the value using the given formatter.

impl From<ErrorBuilder> for OxiGdalError

Convert ErrorBuilder into OxiGdalError

fn from(builder: ErrorBuilder) -> Self

Converts to this type from the input type.