Struct HL7Encoding 

pub struct HL7Encoding {
    pub field_delimiter: char,
    pub component_delimiter: char,
    pub repeat_delimiter: char,
    pub escape_character: char,
    pub subcomponent_delimiter: char,
    pub segment_delimiter: String,
    pub present_but_null: String,
}

HL7 encoding/decoding rules: the field, component, repetition, escape and subcomponent delimiters plus the routines that escape and unescape values.

escape_character uses '\0' to mean “no escape character” (matching the (char)0 sentinel from the original .NET implementation).

Fields

field_delimiter: char

Field delimiter (|, encoded as \F\).

component_delimiter: char

Component delimiter (^, encoded as \S\).

repeat_delimiter: char

Repetition delimiter (~, encoded as \R\).

escape_character: char

Escape character (\, encoded as \E\). '\0' means “disabled”.

subcomponent_delimiter: char

Subcomponent delimiter (&, encoded as \T\).

segment_delimiter: String

Segment delimiter (defaults to \r).

present_but_null: String

String representation of a “present but null” value (defaults to "").

Implementations

impl HL7Encoding

pub fn new() -> Self

Creates an encoding with the default HL7 delimiters.

pub fn all_delimiters(&self) -> String

All delimiter characters concatenated as they appear in MSH-2 (^~\& for the defaults). The escape character is omitted when disabled.

pub fn evaluate_delimiters(&mut self, delimiters: &str) -> Result<(), Hl7Error>

Sets the delimiter characters from the MSH delimiter string in the order field, component, repetition, escape, subcomponent.

When the 5th character equals the field delimiter, the escape character is treated as disabled and the 4th character becomes the subcomponent delimiter.

pub fn evaluate_segment_delimiter( &mut self, message: &str, ) -> Result<(), Hl7Error>

Detects and stores the segment delimiter used in message.

pub fn encode(&self, val: &str) -> String

Escapes HL7 special characters in val according to the current delimiters.

pub fn encode_opt(&self, val: Option<&str>) -> String

Convenience for serialization: encodes Some(value) or returns the “present but null” representation for None.

pub fn decode(&self, encoded: &str) -> String

Decodes an escaped HL7 string back to its original characters.

pub fn decode_hex_string(hex: &str) -> String

Decodes a hexadecimal string (the payload of an \X..\ escape) into a Unicode string.

Trait Implementations

impl Clone for HL7Encoding

fn clone(&self) -> HL7Encoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HL7Encoding

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

Formats the value using the given formatter.

impl Default for HL7Encoding

fn default() -> Self

Returns the “default value” for a type.

impl Eq for HL7Encoding

impl PartialEq for HL7Encoding

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HL7Encoding