Struct InterchangeEnvelope 

#[non_exhaustive]
pub struct InterchangeEnvelope {

    pub syntax_identifier: String,
    pub syntax_version: String,
    pub sender_id: String,
    pub sender_qualifier: String,
    pub sender_routing_address: Option<String>,
    pub recipient_id: String,
    pub recipient_qualifier: String,
    pub recipient_routing_address: Option<String>,
    pub date: String,
    pub time: Option<String>,
    pub control_ref: String,
    pub recipient_password: Option<String>,
    pub recipient_password_qualifier: Option<String>,
    pub app_ref: Option<String>,
    pub processing_priority: Option<String>,
    pub acknowledgement_request: bool,
    pub communications_agreement_id: Option<String>,
    pub test_indicator: bool,
    pub declared_unit_count: u32,
    pub actual_unit_count: u32,
}

Extracted data from the UNB / UNZ interchange envelope.

All standard UNB fields that carry business-relevant information are exposed. Optional fields that are absent in the source are represented as empty strings (syntax_version, qualifiers) or None (optional fields).

UNB element positions (ISO 9735-1 §6.1.1, 0-indexed):

[0] S001  syntax identifier + version
[1] S002  sender id + qualifier + routing
[2] S003  recipient id + qualifier + routing
[3] S004  date + time
[4] 0020  interchange control reference
[5] S005  recipient password (DE 0022 comp 0)
[6] 0026  application reference
[7] 0029  processing priority code
[8] 0031  acknowledgement request
[9] 0032  communications agreement ID
[10] 0035  test indicator

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

syntax_identifier: String

Syntax identifier, e.g. "UNOA" or "UNOB" (UNB S001 DE 0001).

syntax_version: String

Syntax version number, e.g. "3" (UNB S001 DE 0002).

Empty string when the UNB omits the version component.

sender_id: String

Interchange sender identification (UNB S002 DE 0004).

sender_qualifier: String

Interchange sender identification code qualifier (UNB S002 DE 0007).

Common values: "14" (EAN/GLN), "ZZZ" (mutually defined). Empty string when no qualifier is present.

sender_routing_address: Option<String>

Interchange sender routing address (UNB S002 DE 0014), if present.

An optional routing address used by some EDI networks to identify the sub-entity (division, application) within the sender organisation.

recipient_id: String

Interchange recipient identification (UNB S003 DE 0010).

recipient_qualifier: String

Interchange recipient identification code qualifier (UNB S003 DE 0007).

Same values as sender_qualifier. Empty string when absent.

recipient_routing_address: Option<String>

Interchange recipient routing address (UNB S003 DE 0014), if present.

Analogous to sender_routing_address but for the recipient side.

date: String

Interchange date (UNB S004 DE 0017), e.g. "230401" (YYMMDD format).

time: Option<String>

Interchange time (UNB S004 DE 0019), e.g. "0900" (HHMM format), if present.

None when the UNB time component (DE 0019) is absent.

control_ref: String

Interchange control reference (UNB DE 0020).

recipient_password: Option<String>

Recipient’s reference/password (UNB S005 DE 0022), if present.

Used in some EDI networks for basic interchange-level authentication. Empty S005 in the source yields None.

recipient_password_qualifier: Option<String>

Recipient’s reference/password qualifier (UNB S005 DE 0025), if present.

Qualifies the type of the recipient_password. Example value: "AA" (unencoded). None when DE 0025 is absent or empty.

app_ref: Option<String>

Application reference (UNB DE 0026, element index 6), if present.

Identifies the division, department, or section of sender or recipient.

processing_priority: Option<String>

Processing priority code (UNB DE 0029, element index 7), if present.

Indicates the processing priority requested by the sender. Rarely used in practice; included here for full ISO 9735-1 §6.1.1 compliance.

acknowledgement_request: bool

Acknowledgement request flag (UNB DE 0031, element index 8).

true when DE 0031 is "1", indicating that the sender requests a CONTRL functional acknowledgement from the recipient.

communications_agreement_id: Option<String>

Communications agreement identifier (UNB DE 0032, element index 9), if present.

Identifies the agreement controlling the interchange, e.g. "EANCOM".

test_indicator: bool

Test indicator flag (UNB DE 0035, element index 10).

true when DE 0035 is "1". Test interchanges must not be processed as production data — check is_test() before dispatching messages to business logic, billing, or downstream integrations.

declared_unit_count: u32

Interchange unit count declared in UNZ DE 0036.

• When no functional groups are present: count of messages (UNH/UNT pairs).
• When functional groups are present: count of groups (UNG/UNE pairs).

Use ValidatedInterchange::messages for a flat count of all messages regardless of group structure.

actual_unit_count: u32

Actual unit count observed (groups if groups present; messages otherwise).

Implementations

impl InterchangeEnvelope

pub fn is_test(&self) -> bool

Returns true when the test indicator (UNB DE 0035) is set to "1".

Production systems must check this flag before dispatching any message to business logic, billing, or downstream integrations.

Example

// UNB element [10] is the test indicator; "1" means test.
// UNB+UNOA:3+S+R+200101:0900+1++++++1'  ← last element = "1" → is_test() == true
let input = b"UNB+UNOA:3+S+R+200101:0900+CTRL++++++1'\
              UNH+1+ORDERS:D:96A:UN'\
              BGM+220+PO-001+9'\
              UNT+3+1'\
              UNZ+1+CTRL'";
let segs: Vec<_> = edifact_rs::from_bytes(input)
    .collect::<Result<Vec<_>, _>>()
    .unwrap();
let result = edifact_rs::validate_envelope(&segs).unwrap();
assert!(result.interchange.is_test());

pub fn ack_requested(&self) -> bool

Returns true when the acknowledgement request flag (UNB DE 0031) is set.

When true, the sender expects a CONTRL acknowledgement from the recipient.

Trait Implementations

impl Clone for InterchangeEnvelope

fn clone(&self) -> InterchangeEnvelope

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InterchangeEnvelope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InterchangeEnvelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InterchangeEnvelope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for InterchangeEnvelope

impl Hash for InterchangeEnvelope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InterchangeEnvelope

fn eq(&self, other: &InterchangeEnvelope) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for InterchangeEnvelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InterchangeEnvelope