dta 0.6.0

Pure Rust streaming reader and writer for Stata's DTA file format (every released version, 102-119), plus a parser and reader for Stata dictionary (.dct) files.
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

use super::dct_source_options::DctSourceOptions;
use super::schema::Schema;

/// The result of parsing a `.dct` dictionary.
///
/// Distinguishes the two ways a dictionary can be paired with its
/// data: an external file referenced by the `using` clause (or no
/// file at all), vs. data embedded in the same file immediately
/// after the dictionary's closing `}`.
///
/// Both variants surface only the [`Schema`] (and, for embedded
/// data, the buffered reader positioned at the first byte of the
/// data section) — the caller pairs them with
/// [`DctReader::options`](super::dct_reader::DctReader::options) so
/// reader-side knobs like `record_warnings` can be configured
/// uniformly across both paths.
#[derive(Debug)]
pub enum DctSource<R> {
    /// The dictionary references an external data file or none at
    /// all. Pair the schema with your own data reader via
    /// [`DctReader::options`](super::dct_reader::DctReader::options).
    External(Schema),
    /// Data immediately follows the closing `}` in the dictionary
    /// file. `reader` is positioned at the first byte of the data
    /// section; pair it with `schema` via
    /// [`DctReader::options(schema).from_reader(reader)`](super::dct_reader_options::DctReaderOptions::from_reader)
    /// (or the async equivalent) to begin reading records.
    Embedded {
        /// Schema parsed from the dictionary block.
        schema: Schema,
        /// Buffered reader positioned at the first byte of the
        /// data section. Pair with `schema` through
        /// [`DctReader::options`](super::dct_reader::DctReader::options).
        reader: R,
    },
}

impl DctSource<()> {
    /// Creates a [`DctSourceOptions`] builder for parsing a `.dct`
    /// dictionary.
    ///
    /// Call one of `from_reader` / `from_file` / `from_path` on the
    /// returned builder to perform the parse.
    #[must_use]
    #[inline]
    pub fn options() -> DctSourceOptions {
        DctSourceOptions::new()
    }
}

impl<R> DctSource<R> {
    /// Returns the schema regardless of variant.
    #[must_use]
    pub fn schema(&self) -> &Schema {
        match self {
            Self::External(schema) | Self::Embedded { schema, .. } => schema,
        }
    }
}