Struct MessageBuilder

pub struct MessageBuilder { /* private fields */ }

A builder for constructing HL7 messages.

Implementations

impl MessageBuilder

pub fn new(separators: Separators) -> Self

Create a new message builder with the given separators. No segments are added.

pub fn push_segment(&mut self, segment: SegmentBuilder)

Append a segment to the message. Segments will be output in the order they are added.

pub fn separators(&self) -> &Separators

Get the separators used by the message.

pub fn segments(&self) -> &[SegmentBuilder]

Get the segments in the message.

pub fn segments_mut(&mut self) -> &mut Vec<SegmentBuilder>

Get a mutable reference to the segments in the message.

pub fn segment(&self, index: usize) -> Option<&SegmentBuilder>

Get a segment by index (0-based).

pub fn segment_mut(&mut self, index: usize) -> Option<&mut SegmentBuilder>

Get a mutable reference to a segment by index (0-based).

pub fn remove_segment(&mut self, index: usize) -> Option<SegmentBuilder>

Remove a segment by index (0-based).

pub fn segment_named<S: AsRef<str>>(&self, name: S) -> Option<&SegmentBuilder>

Get the first segment with the given name.

pub fn segment_named_mut<S: AsRef<str>>( &mut self, name: S, ) -> Option<&mut SegmentBuilder>

Get a mutable reference to the first segment with the given name.

pub fn remove_segment_named<S: AsRef<str>>( &mut self, name: S, ) -> Option<SegmentBuilder>

Remove the first segment with the given name.

pub fn segment_n<S: AsRef<str>>( &self, name: S, n: usize, ) -> Option<&SegmentBuilder>

Get the nth segment with the given name (1-based).

pub fn segment_n_mut<S: AsRef<str>>( &mut self, name: S, n: usize, ) -> Option<&mut SegmentBuilder>

Get a mutable reference to the nth segment with the given name (1-based).

pub fn remove_segment_n<S: AsRef<str>>( &mut self, name: S, n: usize, ) -> Option<SegmentBuilder>

Remove the nth segment with the given name (1-based).

pub fn is_empty(&self) -> bool

Check if the message is empty (i.e. has no segments).

pub fn clear(&mut self)

Clear all segments from the message.

pub fn set_separators(&mut self, separators: Separators)

Set the separators used by the message.

pub fn with_segment(self, segment: SegmentBuilder) -> Self

Add a segment to the message.

pub fn render_with_newlines(&self) -> MessageBuilderDisplay<'_>

Display the message with the default line endings for the current platform.

On Windows, this will use \r\n as the line ending. On other platforms, it will use \n.

pub fn render_with_segment_separators<'a>( &'a self, line_endings: &'a str, ) -> MessageBuilderDisplay<'a>

Display the message with the given line endings.

Trait Implementations

impl Clone for MessageBuilder

fn clone(&self) -> MessageBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageBuilder

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

Formats the value using the given formatter.

impl Default for MessageBuilder

fn default() -> MessageBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MessageBuilder

Render the message using the proper \r segment separators.

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

Formats the value using the given formatter.

impl<'m> From<&'m Message<'m>> for MessageBuilder

Convert a message into a message builder.

fn from(message: &'m Message<'_>) -> Self

Converts to this type from the input type.

impl PartialEq for MessageBuilder

fn eq(&self, other: &MessageBuilder) -> 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 Serialize for MessageBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MessageBuilder

impl StructuralPartialEq for MessageBuilder