Struct calamine::RangeDeserializerBuilder

pub struct RangeDeserializerBuilder<'h, H: 'h> { /* fields omitted */ }

Builds a Range deserializer with some configuration options.

This can be used to optionally parse the first row as a header. Once built, a RangeDeserializers cannot be changed.

Methods

impl RangeDeserializerBuilder<'static, &'static str>

pub fn new() -> Self

Constructs a new builder for configuring Range deserialization.

pub fn has_headers(&mut self, yes: bool) -> &mut Self

Decide whether to treat the first row as a special header row.

Example

fn example() -> Result<(), Error> {
    let path = format!("{}/tests/temperature.xlsx", env!("CARGO_MANIFEST_DIR"));
    let mut workbook: Xlsx<_> = open_workbook(path)?;
    let range = workbook.worksheet_range("Sheet1")
        .ok_or(Error::Msg("Cannot find 'Sheet1'"))??;

    let mut iter = RangeDeserializerBuilder::new()
        .has_headers(false)
        .from_range(&range)?;

    if let Some(result) = iter.next() {
        let row: Vec<DataType> = result?;
        assert_eq!(row, [DataType::from("label"), DataType::from("value")]);
    } else {
        return Err(From::from("expected at least three records but got none"));
    }

    if let Some(result) = iter.next() {
        let row: Vec<DataType> = result?;
        assert_eq!(row, [DataType::from("celsius"), DataType::from(22.2222)]);
    } else {
        return Err(From::from("expected at least three records but got one"));
    }

    Ok(())
}

impl<'h, H: AsRef<str> + Clone + 'h> RangeDeserializerBuilder<'h, H>

pub fn with_headers(headers: &'h [H]) -> Self

Build a RangeDeserializer from this configuration and keep only selected headers.

Example

fn example() -> Result<(), Error> {
    let path = format!("{}/tests/temperature.xlsx", env!("CARGO_MANIFEST_DIR"));
    let mut workbook: Xlsx<_> = open_workbook(path)?;
    let range = workbook.worksheet_range("Sheet1")
        .ok_or(Error::Msg("Cannot find 'Sheet1'"))??;
    let mut iter = RangeDeserializerBuilder::with_headers(&["value", "label"]).from_range(&range)?;

    if let Some(result) = iter.next() {
        let (value, label): (f64, String) = result?;
        assert_eq!(label, "celsius");
        assert_eq!(value, 22.2222);

        Ok(())
    } else {
        return Err(From::from("expected at least one record but got none"));
    }
}

pub fn from_range<'cell, T, D>(
    &self,
    range: &'cell Range<T>
) -> Result<RangeDeserializer<'cell, T, D>, DeError> where
    T: ToCellDeserializer<'cell>,
    D: DeserializeOwned, 

Build a RangeDeserializer from this configuration.

Example

fn example() -> Result<(), Error> {
    let path = format!("{}/tests/temperature.xlsx", env!("CARGO_MANIFEST_DIR"));
    let mut workbook: Xlsx<_> = open_workbook(path)?;
    let range = workbook.worksheet_range("Sheet1")
        .ok_or(Error::Msg("Cannot find 'Sheet1'"))??;
    let mut iter = RangeDeserializerBuilder::new().from_range(&range)?;

    if let Some(result) = iter.next() {
        let (label, value): (String, f64) = result?;
        assert_eq!(label, "celsius");
        assert_eq!(value, 22.2222);

        Ok(())
    } else {
        return Err(From::from("expected at least one record but got none"));
    }
}

Trait Implementations

impl<'h, H: Clone + 'h> Clone for RangeDeserializerBuilder<'h, H>

fn clone(&self) -> RangeDeserializerBuilder<'h, H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for RangeDeserializerBuilder<'static, &'static str>

fn default() -> Self

Returns the "default value" for a type.