dta 0.5.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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

//! Reader for Stata dictionary (`.dct`) files.
//!
//! A `.dct` dictionary describes the schema of a fixed-width or
//! free-format plain-text data file. This module parses the
//! dictionary, then iterates observations from the associated data
//! file. Data may be embedded after the dictionary's closing `}` or
//! live in a separate file; see [`DctSource`](crate::stata::dct::DctSource).
//!
//! Unlike the binary DTA format, DCT files are plain ASCII and never
//! carry `strL` references, so the DCT-domain
//! [`Value`](crate::stata::dct::Value) /
//! [`VariableType`](crate::stata::dct::VariableType) types
//! deliberately diverge from their DTA counterparts.
//!
//! # Line endings
//!
//! Both Unix `\n` and Windows `\r\n` line endings are accepted in
//! both the dictionary file and its associated data file. Classic
//! Mac `\r`-only line endings are not — Stata never emitted them and
//! supporting them would require a different reading strategy. A
//! `\r`-delimited file would be read as a single very long line.

#[cfg(feature = "tokio")]
/// Async data-row reader paired with a parsed schema.
pub mod async_dct_reader;
#[cfg(feature = "tokio")]
mod async_parser;
/// Per-variable column declaration parsed from the dictionary.
pub mod column;
/// Where a column's first byte sits within its physical line —
/// statically known or runtime-resolved.
pub mod column_anchor;
/// Error type for DCT parsing and reading.
pub mod dct_error;
/// Data-row reader paired with a parsed schema.
pub mod dct_reader;
/// Options builder for constructing a [`DctReader`].
pub mod dct_reader_options;
mod dct_reader_state;
/// External vs. embedded data classification returned by the parser.
pub mod dct_source;
/// Options builder for parsing a [`DctSource`].
pub mod dct_source_options;
mod dct_source_state;
/// Non-fatal warning channel.
pub mod dct_warning;
/// Input format vocabulary derived from the `%infmt` token.
pub mod input_format;
/// Observation that decodes its values on demand.
pub mod lazy_record;
mod line_ending;
/// Numeric sub-format (fixed-point, general, scientific) implied by a
/// fixed-width numeric `%infmt`.
pub mod numeric_style;
mod parser;
/// A single parsed observation.
pub mod record;
/// The parsed dictionary, excluding data.
pub mod schema;
/// A single parsed cell value.
pub mod value;
/// Storage type vocabulary used by `DctColumn`.
pub mod variable_type;

#[cfg(feature = "tokio")]
pub use async_dct_reader::AsyncDctReader;
pub use column::Column;
pub use column_anchor::ColumnAnchor;
pub use dct_error::{DctError, Result};
pub use dct_reader::DctReader;
pub use dct_reader_options::DctReaderOptions;
pub use dct_source::DctSource;
pub use dct_source_options::DctSourceOptions;
pub use dct_warning::DctWarning;
pub use input_format::InputFormat;
pub use lazy_record::LazyRecord;
pub use numeric_style::NumericStyle;
pub use record::Record;
pub use schema::Schema;
pub use value::Value;
pub use variable_type::VariableType;