sas7bdat 0.2.0

Rust library + CLI for decoding SAS7BDAT datasets and streaming them to modern formats.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

#[cfg(feature = "parquet")]
use parquet::errors::ParquetError;
use std::{borrow::Cow, fmt, io};

/// Result type used across the high-level SAS reader implementation.
pub type Result<T> = std::result::Result<T, Error>;

/// High-level error type surfaced by the idiomatic SAS reader.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// I/O failure while reading from the underlying data source.
    #[error(transparent)]
    Io(#[from] io::Error),

    /// Failure to convert bytes between character encodings.
    #[error("encoding conversion from {encoding} failed: {details}")]
    Encoding {
        encoding: Cow<'static, str>,
        details: Cow<'static, str>,
    },

    /// The file appears to be corrupt or inconsistent while processing a section.
    #[error("corrupted SAS file while processing {section}: {details}")]
    Corrupted {
        section: Section,
        details: Cow<'static, str>,
    },

    /// SAS features that are not yet implemented in the pure Rust reader.
    #[error("unsupported SAS feature: {feature}")]
    Unsupported { feature: Cow<'static, str> },

    /// Metadata or schema could not be interpreted according to expectations.
    #[error("invalid SAS metadata: {details}")]
    InvalidMetadata { details: Cow<'static, str> },

    /// Failure encountered while interacting with the Parquet writer.
    #[error("parquet error: {details}")]
    Parquet { details: Cow<'static, str> },

    /// Failed to allocate or grow internal buffers.
    #[error("allocation failed: {details}")]
    Allocation { details: Cow<'static, str> },
}

/// Logical section of the parser used for diagnostic reporting.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Section {
    Header,
    Page { index: u64 },
    Subheader { page_index: u64, signature: u32 },
    Row { index: u64 },
    Column { index: u32 },
    Decompression { page_index: u64 },
    Encoding,
}

impl Section {
    /// Helper constructor for subheader sections when the raw signature is known.
    #[must_use]
    pub const fn subheader(page_index: u64, signature: u32) -> Self {
        Self::Subheader {
            page_index,
            signature,
        }
    }
}

#[cfg(feature = "parquet")]
impl From<ParquetError> for Error {
    fn from(err: ParquetError) -> Self {
        Self::Parquet {
            details: Cow::Owned(err.to_string()),
        }
    }
}

impl fmt::Display for Section {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Header => write!(f, "file header"),
            Self::Page { index } => write!(f, "page {index}"),
            Self::Subheader {
                page_index,
                signature,
            } => write!(
                f,
                "subheader signature 0x{signature:08X} on page {page_index}"
            ),
            Self::Row { index } => write!(f, "row {index}"),
            Self::Column { index } => write!(f, "column {index}"),
            Self::Decompression { page_index } => {
                write!(f, "page {page_index} during decompression")
            }
            Self::Encoding => write!(f, "character encoding conversion"),
        }
    }
}