hl7-parser 0.3.0

Parses the structure of HL7v2 messages, but does not validate the correctness of the messages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

use crate::display::SegmentDisplay;
use std::ops::Range;

use super::{Field, Separators};

/// A segment in an HL7 message. A segment is a collection of fields, separated by the field
/// separator character. Each segment has a name, which is the first field in the segment.
/// Segments are separated by the segment separator character.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct Segment<'m> {
    pub(crate) source: &'m str,
    /// The name of the segment
    pub name: &'m str,
    /// The fields of the segment
    pub fields: Vec<Field<'m>>,
    /// The range of the segment in the original message
    pub range: Range<usize>,
}

impl<'m> Segment<'m> {
    #[inline]
    /// An iterator over the fields of the segment
    pub fn fields(&self) -> impl Iterator<Item = &Field<'m>> {
        self.fields.iter()
    }

    #[inline]
    /// Display the segment value, using the separators to decode escape sequences
    /// by default. Note: if you want to display the raw value without decoding escape
    /// sequences, use the `#` flag, e.g. `format!("{:#}", segment.display(separators))`.
    /// Repeats will be separated by the repeat separator character.
    /// Fields will be separated by the field separator character.
    /// Components will be separated by the component separator character.
    /// Subcomponents will be separated by the subcomponent separator character.
    /// Segments will be separated by the segment separator character.
    /// Escape sequences will be decoded using the escape character.
    pub fn display(&'m self, separators: &'m Separators) -> SegmentDisplay<'m> {
        SegmentDisplay {
            name: self.name,
            fields: &self.fields,
            separators,
        }
    }

    #[inline]
    /// Get the raw value of the segment. This is the value as it appears in the message,
    /// without any decoding of escape sequences, and including all fields and
    /// their separators.
    ///
    /// # Examples
    ///
    /// ```
    /// let segment = hl7_parser::parser::parse_segment("ZFO|foo|bar").unwrap();
    /// assert_eq!(segment.name, "ZFO");
    /// assert_eq!(segment.fields.len(), 2);
    /// assert_eq!(segment.raw_value(), "ZFO|foo|bar");
    /// ```
    pub fn raw_value(&self) -> &'m str {
        self.source
    }

    #[inline]
    /// Get a specific field of the segment by number. Fields are numbered starting at 1.
    /// Returns `None` if the field number is out of range.
    ///
    /// # Examples
    ///
    /// ```
    /// let segment = hl7_parser::parser::parse_segment("ZFO|foo|bar").unwrap();
    /// assert_eq!(segment.field(1).unwrap().raw_value(), "foo");
    /// assert_eq!(segment.field(2).unwrap().raw_value(), "bar");
    /// assert_eq!(segment.field(3), None);
    /// ```
    pub fn field(&self, number: usize) -> Option<&Field<'m>> {
        debug_assert!(number > 0, "Field numbers are 1-indexed");
        self.fields.get(number - 1)
    }
}