lance-format/lance

Add `ReadFileError` and `DecodeColumnError` wrappers to provide better context for decoding errors

Open

#5602 aperta il 31 dic 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Rust (695 fork)github user discovery
good first issue

Metriche repository

Star
 (6582 star)
Metriche merge PR
 (Merge medio 6g 1h) (219 PR mergiate in 30 g)

Descrizione

Currently, errors that happen when decoding a column are missing information about:

  1. What column that is
  2. What file we are reading

This context is available higher up in the call stack that the main error is generate. We can add additional context by adding wrapper errors.

This approach is described nicely in https://sabrinajewson.org/blog/errors.

Basically, want to do things like:

enum DecodeError {
    NumberOutOfRange,
    ...
}

struct DecodeFieldError {
    field_name: String,
    field_id: i32,
    offset: u64,
    source: DecodeError,
}

fn decode(field: Field, data: Bytes) -> Result<_, DecodeFieldError> {
    ...
}

enum ReadFileErrorKind {
    IO(ObjectStoreError),
    Decode(DecodeFieldError),
}

struct ReadFileError {
    path: Path,
    kind: ReadFileErrorKind,
}

fn read_file(path: Path) -> Result<_, ReadFileError> {
    let data = read_data(path)?;
    for field in data.schema() {
        decode(field, data).map_err(|err: DecodeFieldError| {
            ReadFileError { path, kind: ReadFileErrorKind::Decode(err) }
        });
    }
}

And then the error stack would look like:

Error: failed to read file 'data.lance'

Caused by:
    0: failed to read field 'age' (id: 10) for row offset 10
    1: number out of range

Guida contributor