Struct Encoding 

pub struct Encoding {
    pub field: u8,
    pub component: u8,
    pub repetition: u8,
    pub escape: u8,
    pub subcomponent: u8,
}

The five delimiter characters of an HL7 v2 message.

The field separator is MSH-1 (byte 3 of the message); the other four are MSH-2, in the order component, repetition, escape, subcomponent. HL7 2.7 adds an optional fifth truncation character which this crate ignores.

Fields

field: u8

Field separator, conventionally |.

component: u8

Component separator, conventionally ^.

repetition: u8

Repetition separator, conventionally ~.

escape: u8

Escape character, conventionally \.

subcomponent: u8

Subcomponent separator, conventionally &.

Implementations

impl Encoding

pub const STANDARD: Encoding

The standard encoding, |^~\&.

pub fn from_msh2(field: u8, msh2: &[u8]) -> Option<Encoding>

Build an encoding from the field separator (MSH-1) and the raw bytes of MSH-2. Returns None when MSH-2 is malformed: fewer than four or more than five bytes, non-ASCII, duplicated, or colliding with the field separator. Callers should fall back to Encoding::with_field.

pub fn with_field(field: u8) -> Encoding

The standard encoding characters with a custom field separator.

pub fn msh2(&self) -> String

The MSH-2 value that declares this encoding, e.g. ^~\&.

Trait Implementations

impl Clone for Encoding

fn clone(&self) -> Encoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Encoding

impl Debug for Encoding

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

Formats the value using the given formatter.

impl Default for Encoding

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Encoding

impl Hash for Encoding

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 Encoding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Encoding