Overview

Nota bene: There are some instances which will cause panics at parse time. Those are still being worked on. The instances in question are:

• Adding a functional group with no iterchange (encountering a GS segment before an ISA segment)
• Adding a transaction without a functional group in the interchange (encountering an ST segment before a GS in an interchange)
• Adding a segment without a transaction (encountering any segment without a containing ST segment)

If you are parsing valid EDI documents, the parser will never panic.

A quick summary of features

• Provides two top-level parsing functions: parse and loose_parse. loose_parse is less strict on the format of the incoming EDI document.
• Parses a valid X12 EDI document into a struct called EdiDocument.
• Provides verbose error messages if the document being parsed is invalid.
• EdiDocument and all data it contains implement Serialize and Deserialize from serde, so zero-copy serialization and deserialization to any serde-able format is supported (this includes json).
• EdiDocument's fields are all public and it can be navigated like any other struct for simplicity

A quick summary of limitations

• Cannot accurately determine segment types, as that requires an implementation guide from the individual transactor
• Cannot detect loops for the same reason as above
• Only supports standard X12 EDI

Roadmap

• benches to identify regressions
• output back into EDI with proper padding in the ISA segment
• iterator over segments for the frequent cases in which there's only one transaction/functional group/interchange (EdiDocument.segments_iter() -> SegmentIter?)
  • to_string(delimiters) is needed to output the edi document
• Convert panics into bubbling EdiParseErrors