Enum SyntaxError 

#[non_exhaustive]
pub enum SyntaxError {
    SyntaxVersionNotSupported,
    NotActualRecipient,
    InvalidValue,
    Missing,
    ValueNotSupportedHere,
    NotSupportedHere,
    TooManyConstituents,
    NoAgreement,
    Unspecified,
    InvalidAsServiceCharacter,
    InvalidCharacters,
    InvalidServiceCharacters,
    UnknownSender,
    TooOld,
    TestIndicatorNotSupported,
    DuplicateDetected,
    ReferencesDoNotMatch,
    ControlCountMismatch,
    GroupsAndMessagesMixed,
    LowerLevelEmpty,
    InvalidOccurrenceOutsideMessage,
    TooManyRepetitions,
    TooManyGroupRepetitions,
    InvalidCharacterType,
    DataElementTooLong,
    DataElementTooShort,
    TrailingSeparator,
    CharacterSetNotSupported,
    EnvelopeFunctionalityNotSupported,
}

CONTRL syntax error code — DE 0085, the nature of one fault.

The variants are exactly the code set of ISO 9735-4 Annex A, and permitted_at reproduces that annex’s table of which code may be used at which reporting level. Emitting a code at a level the annex forbids produces a CONTRL the partner’s translator will reject, so Contrl checks it rather than trusting the caller.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SyntaxVersionNotSupported

2 — syntax version or level not supported.

NotActualRecipient

7 — interchange recipient not actual recipient.

InvalidValue

12 — invalid value.

Missing

13 — missing.

ValueNotSupportedHere

14 — value not supported in this position.

NotSupportedHere

15 — not supported in this position.

TooManyConstituents

16 — too many constituents.

NoAgreement

17 — no agreement.

Unspecified

18 — unspecified error.

InvalidAsServiceCharacter

20 — character invalid as service character.

InvalidCharacters

21 — invalid character(s).

InvalidServiceCharacters

22 — invalid service character(s).

UnknownSender

23 — unknown interchange sender.

TooOld

24 — too old.

TestIndicatorNotSupported

25 — test indicator not supported.

DuplicateDetected

26 — duplicate detected.

ReferencesDoNotMatch

28 — references do not match.

ControlCountMismatch

29 — control or octet count does not match number of instances received.

GroupsAndMessagesMixed

30 — groups and messages/packages mixed.

LowerLevelEmpty

32 — lower level empty.

InvalidOccurrenceOutsideMessage

33 — invalid occurrence outside message, package or group.

TooManyRepetitions

35 — too many repetitions.

TooManyGroupRepetitions

36 — too many segment group repetitions.

InvalidCharacterType

37 — invalid type of character(s).

DataElementTooLong

39 — data element too long.

DataElementTooShort

40 — data element too short.

TrailingSeparator

45 — trailing separator.

CharacterSetNotSupported

46 — character set not supported.

EnvelopeFunctionalityNotSupported

47 — envelope functionality not supported.

Implementations

impl SyntaxError

pub const fn code(self) -> &'static str

The DE 0085 code value.

pub const fn description(self) -> &'static str

The Annex A code name.

pub const fn permitted_at(self, level: ReportingLevel) -> bool

Whether ISO 9735-4 Annex A allows this code at level.

Example

use edifact_rs::contrl::{ReportingLevel, SyntaxError};

// "Too many segment group repetitions" is a segment-level finding only.
assert!(SyntaxError::TooManyGroupRepetitions.permitted_at(ReportingLevel::Segment));
assert!(!SyntaxError::TooManyGroupRepetitions.permitted_at(ReportingLevel::Interchange));

// "Unknown interchange sender" can only be said about the interchange.
assert!(SyntaxError::UnknownSender.permitted_at(ReportingLevel::Interchange));
assert!(!SyntaxError::UnknownSender.permitted_at(ReportingLevel::Message));

pub fn for_error(error: &EdifactError) -> Self

The CONTRL code that best names an EdifactError.

ISO 9735-4 §5.3.3 asks for the most precise code available and warns against reaching for a general one when a specific one fits, so this maps each variant to the narrowest Annex A code that is true of it, falling back to 18 (unspecified) only where the annex genuinely offers nothing better.

Example

use edifact_rs::contrl::SyntaxError;
use edifact_rs::EdifactError;

let err = EdifactError::MessageCountMismatch { expected: 2, actual: 1 };
assert_eq!(SyntaxError::for_error(&err), SyntaxError::ControlCountMismatch);
assert_eq!(SyntaxError::for_error(&err).code(), "29");

pub fn for_issue(issue: &ValidationIssue) -> Self

The best CONTRL code for a ValidationIssue, via its stable code.

Works for issues raised by any validator, including third-party ones, because it reads ValidationIssue::error_code rather than needing the original EdifactError. An issue with no stable code — a profile rule finding, typically — is 18 (unspecified), which is what the annex provides for a fault it does not name.

Trait Implementations

impl Clone for SyntaxError

fn clone(&self) -> SyntaxError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SyntaxError

impl Debug for SyntaxError

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

Formats the value using the given formatter.

impl Display for SyntaxError

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

Formats the value using the given formatter.

impl Eq for SyntaxError

impl Hash for SyntaxError

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 SyntaxError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SyntaxError