feat: add helper method

tafia · Oct 6, 2024 · 23f4c26 · 23f4c26
1 parent 72e74b0
commit 23f4c26
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 8 deletions.
diff --git a/src/auto.rs b/src/auto.rs
@@ -115,6 +115,24 @@ where
         }
     }
 
+    fn with_header_row(&mut self, header_row: Option<u32>) -> &mut Self {
+        match self {
+            Sheets::Xls(ref mut e) => {
+                e.with_header_row(header_row);
+            }
+            Sheets::Xlsx(ref mut e) => {
+                e.with_header_row(header_row);
+            }
+            Sheets::Xlsb(ref mut e) => {
+                e.with_header_row(header_row);
+            }
+            Sheets::Ods(ref mut e) => {
+                e.with_header_row(header_row);
+            }
+        }
+        self
+    }
+
     /// Gets `VbaProject`
     fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, Self::Error>> {
         match self {

diff --git a/src/lib.rs b/src/lib.rs
@@ -246,6 +246,9 @@ where
         self
     }
 
+    /// Set current header row
+    fn with_header_row(&mut self, header_row: Option<u32>) -> &mut Self;
+
     /// Gets `VbaProject`
     fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, Self::Error>>;
 

diff --git a/src/ods.rs b/src/ods.rs
@@ -192,6 +192,11 @@ where
         self.options = options;
     }
 
+    fn with_header_row(&mut self, header_row: Option<u32>) -> &mut Self {
+        self.options.header_row = header_row;
+        self
+    }
+
     /// Gets `VbaProject`
     fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, OdsError>> {
         None

diff --git a/src/xls.rs b/src/xls.rs
@@ -261,6 +261,11 @@ impl<RS: Read + Seek> Reader<RS> for Xls<RS> {
         self.options = options;
     }
 
+    fn with_header_row(&mut self, header_row: Option<u32>) -> &mut Self {
+        self.options.header_row = header_row;
+        self
+    }
+
     fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, XlsError>> {
         self.vba.as_ref().map(|vba| Ok(Cow::Borrowed(vba)))
     }

diff --git a/src/xlsb/mod.rs b/src/xlsb/mod.rs
@@ -486,6 +486,11 @@ impl<RS: Read + Seek> Reader<RS> for Xlsb<RS> {
         self.options = options;
     }
 
+    fn with_header_row(&mut self, header_row: Option<u32>) -> &mut Self {
+        self.options.header_row = header_row;
+        self
+    }
+
     fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, XlsbError>> {
         self.zip.by_name("xl/vbaProject.bin").ok().map(|mut f| {
             let len = f.size() as usize;

diff --git a/src/xlsx/mod.rs b/src/xlsx/mod.rs
@@ -900,6 +900,11 @@ impl<RS: Read + Seek> Reader<RS> for Xlsx<RS> {
         self.options = options;
     }
 
+    fn with_header_row(&mut self, header_row: Option<u32>) -> &mut Self {
+        self.options.header_row = header_row;
+        self
+    }
+
     fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, XlsxError>> {
         let mut f = self.zip.by_name("xl/vbaProject.bin").ok()?;
         let len = f.size() as usize;

diff --git a/tests/test.rs b/tests/test.rs
@@ -1,8 +1,8 @@
 use calamine::Data::{Bool, DateTime, DateTimeIso, DurationIso, Empty, Error, Float, Int, String};
 use calamine::{
     open_workbook, open_workbook_auto, DataRef, DataType, Dimensions, ExcelDateTime,
-    ExcelDateTimeType, Ods, OdsOptions, Range, Reader, ReaderOptions, ReaderRef, Sheet, SheetType,
-    SheetVisible, Xls, XlsOptions, Xlsb, XlsbOptions, Xlsx, XlsxOptions,
+    ExcelDateTimeType, Ods, Range, Reader, ReaderRef, Sheet, SheetType, SheetVisible, Xls, Xlsb,
+    Xlsx,
 };
 use calamine::{CellErrorType::*, Data};
 use rstest::rstest;
@@ -1824,7 +1824,7 @@ fn test_header_row_xlsx(
     );
 
     let range = excel
-        .with_options(XlsxOptions { header_row })
+        .with_header_row(header_row)
         .worksheet_range("Sheet1")
         .unwrap();
     assert_eq!(range.start(), Some(expected_start));
@@ -1837,11 +1837,11 @@ fn test_header_row_xlsx(
 fn test_read_twice_with_different_header_rows() {
     let mut xlsx: Xlsx<_> = wb("any_sheets.xlsx");
     let _ = xlsx
-        .with_options(XlsxOptions::default().with_header_row(2))
+        .with_header_row(Some(2))
         .worksheet_range("Visible")
         .unwrap();
     let _ = xlsx
-        .with_options(XlsxOptions::default().with_header_row(1))
+        .with_header_row(Some(1))
         .worksheet_range("Visible")
         .unwrap();
 }
@@ -1882,7 +1882,7 @@ fn test_header_row_xlsb() {
     assert_eq!(range.rows().nth(1).unwrap(), &second_line);
 
     let range = xlsb
-        .with_options(XlsbOptions::default().with_header_row(1))
+        .with_header_row(Some(1))
         .worksheet_range("Sheet1")
         .unwrap();
     assert_eq!(range.start(), Some((1, 0)));
@@ -1926,7 +1926,7 @@ fn test_header_row_xls() {
     assert_eq!(range.rows().nth(1).unwrap(), &second_line);
 
     let range = xls
-        .with_options(XlsOptions::default().with_header_row(1))
+        .with_header_row(Some(1))
         .worksheet_range("Sheet1")
         .unwrap();
     assert_eq!(range.start(), Some((1, 0)));
@@ -1956,7 +1956,7 @@ fn test_header_row_ods() {
     assert_eq!(range.rows().nth(2).unwrap(), &third_line);
 
     let range = ods
-        .with_options(OdsOptions::default().with_header_row(2))
+        .with_header_row(Some(2))
         .worksheet_range("Sheet1")
         .unwrap();
     assert_eq!(range.start(), Some((2, 0)));