Skip to main content

card_messages/
lib.rs

1//! Streaming parsing for card clearing messages.
2//!
3//! The crate reads VBS record streams, optionally removes 1014-byte blocking,
4//! and parses the supported ISO 8583 data elements into explicit Rust types.
5//! [`IpmReader`] is the main entry point; [`Message`] describes each record.
6//!
7//! # Example
8//!
9//! ```
10//! use std::io::Cursor;
11//! use card_messages::{Blocking, IpmReader, ReaderOptions, TextEncoding};
12//!
13//! let options = ReaderOptions {
14//!     blocking: Blocking::None,
15//!     encoding: TextEncoding::Latin1,
16//!     ..ReaderOptions::default()
17//! };
18//! let input = Cursor::new([0_u8; 4]);
19//! let mut records = IpmReader::new(input, options);
20//! assert!(records.next().is_none());
21//! ```
22
23mod encoding;
24mod error;
25mod field_spec;
26mod logical_file;
27mod message;
28mod profile;
29mod reader;
30mod validation;
31
32pub use encoding::TextEncoding;
33pub use error::{
34    InvalidBlockDetail, PARSE_FAIL_SITE_BYTES, PARSE_FIELD_PREVIEW_BYTES, PARSE_RECORD_START_BYTES,
35    ParseError, ParseErrorDetail, ParseErrorKind, ParseFieldSnapshot, format_wire_preview,
36};
37pub use field_spec::{DEFAULT_FIELD_SPEC_YAML, FieldSpecError, FieldSpecTable};
38pub use logical_file::LogicalFileValidator;
39pub use message::{
40    AdditionalAmount, BinaryPds, CardAcceptorLocation, DataElement3, DataElement22, DataElement30,
41    DataElement31, DataElement54, DataElement55, DataElement63, DataElement105,
42    DataElement105Subelement, DataElementNumber, DataElementValue, LocalDateTime, Message,
43    MessageTypeIndicator, Pds, PdsTag, Tlv, UnparsedDataElement,
44};
45pub use profile::{MessageCategory, MessageProfile, MessageValidator, message_profiles};
46pub use reader::{Blocking, IpmReader, ReaderOptions};
47pub use validation::{
48    ValidationAction, ValidationContext, ValidationIssue, ValidationPolicy, ValidationRule,
49};