Struct Message 

pub struct Message { /* private fields */ }

A parsed HL7 v2 message.

The message owns a copy of the input text; all views borrow from it.

Implementations

impl Message

pub fn parse(text: impl Into<String>) -> Result<Message, ParseError>

Parse a message from text.

pub fn parse_bytes(bytes: &[u8]) -> Result<Message, ParseError>

Parse a message from bytes that must be valid UTF-8.

pub fn parse_lossy(bytes: &[u8]) -> Result<Message, ParseError>

Parse a message from bytes, replacing invalid UTF-8 sequences. Spans refer to the converted text available through Message::raw, not to the original bytes.

pub fn raw(&self) -> &str

The message text that all spans index into.

pub fn encoding(&self) -> Encoding

The encoding characters in effect.

pub fn warnings(&self) -> &[Warning]

Tolerated irregularities in the input.

pub fn segment_count(&self) -> usize

Number of segments.

pub fn segments(&self) -> impl Iterator<Item = Segment<'_>> + '_

All segments in order.

pub fn segment_at(&self, index: usize) -> Option<Segment<'_>>

The segment at position index (zero-based).

pub fn segment(&self, name: &str) -> Option<Segment<'_>>

The first segment with the given name (case-insensitive).

pub fn segments_named( &self, name: &str, ) -> impl Iterator<Item = Segment<'_>> + '_

All segments with the given name (case-insensitive).

pub fn get(&self, path: &str) -> Option<&str>

Look up a value by path, e.g. PID-3.1. See Path for the syntax.

Returns None when the path does not parse or the addressed element is absent. Use Path::parse first to distinguish the two.

pub fn get_decoded(&self, path: &str) -> Option<Cow<'_, str>>

Like Message::get but decodes escape sequences.

pub fn get_span(&self, path: &str) -> Option<Span>

The span of the element addressed by path.

pub fn resolve(&self, path: &Path) -> Option<Span>

Resolve a parsed path to a span.

pub fn decode<'a>(&self, text: &'a str) -> Cow<'a, str>

Decode escape sequences in text with this message’s encoding.

pub fn message_type(&self) -> Option<MessageType<'_>>

MSH-9, the message type.

pub fn control_id(&self) -> Option<&str>

MSH-10, the message control ID.

pub fn version(&self) -> Option<&str>

MSH-12.1, the HL7 version.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.