feat(rust): make error-related types public (#396)

* feat(rust): make error-related types public

Signed-off-by: Luka Peschke <luka.peschke@toucantoco.com>

* fix(deps): loosen upper constraint on `log` crate

Signed-off-by: Luka Peschke <luka.peschke@toucantoco.com>

---------

Signed-off-by: Luka Peschke <luka.peschke@toucantoco.com>

Author: lukapeschke

Cargo.toml

@@ -31,7 +31,7 @@ arrow-pyarrow = { version = "^56.1.0", optional = true }
 arrow-schema = { version = "^56.1.0", optional = true }
 calamine = { version = "^0.30.1", features = ["dates"] }
 chrono = { version = "^0.4.42", default-features = false }
-log = "^0.4.28"
+log = "^0.4"
 polars-core = { version = ">=0.50", default-features = false, features = [
     "dtype-date",
     "dtype-datetime",

src/error.rs

@@ -2,6 +2,7 @@ use crate::types::idx_or_name::IdxOrName;
 use calamine::XlsxError;
 use std::{error::Error, fmt::Display};
 
+/// The kind of a fastexcel error.
 #[derive(Debug)]
 pub enum FastExcelErrorKind {
     UnsupportedColumnTypeCombination(String),
@@ -49,6 +50,10 @@ impl Display for FastExcelErrorKind {
     }
 }
 
+/// A `fastexcel` error.
+///
+/// Contains a kind and a context. Use the `Display` trait to format the
+/// error message with its context.
 #[derive(Debug)]
 pub struct FastExcelError {
     pub kind: FastExcelErrorKind,
@@ -109,7 +114,7 @@ impl From<XlsxError> for FastExcelError {
     }
 }
 
-pub(crate) type FastExcelResult<T> = Result<T, FastExcelError>;
+pub type FastExcelResult<T> = Result<T, FastExcelError>;
 
 impl<T> ErrorContext for FastExcelResult<T> {
     fn with_context<S: ToString, F>(self, ctx_fn: F) -> Self

src/lib.rs

@@ -13,13 +13,13 @@ use pyo3::prelude::*;
 use types::excelsheet::{CellError, CellErrors};
 
 pub use data::{FastExcelColumn, FastExcelSeries};
+use error::ErrorContext;
+pub use error::{FastExcelError, FastExcelErrorKind, FastExcelResult};
 pub use types::{
     ColumnInfo, ColumnNameFrom, DType, DTypeCoercion, DTypeFrom, DTypes, ExcelReader, ExcelSheet,
     ExcelTable, IdxOrName, LoadSheetOrTableOptions, SelectedColumns, SheetVisible, SkipRows,
 };
 
-use crate::error::{ErrorContext, FastExcelResult};
-
 /// Reads an excel file and returns an object allowing to access its sheets, tables, and a bit of metadata.
 /// This is a wrapper around `ExcelReader::try_from_path`.
 pub fn read_excel<S: AsRef<str> + Display>(path: S) -> FastExcelResult<ExcelReader> {