Skip to main content

Node

Struct Node 

Source
pub struct Node { /* private fields */ }
Expand description

One node of the generic tree.

A node is either a container (a group, a segment, or a field/component whose type the dictionary can break apart) or a leaf holding text. Node::text answers for both: on a container it is the decoded text of everything beneath, delimiters included, so PID.5 reads as SMITH^JOHN whether or not the dictionary knew what an XPN is.

Implementations§

Source§

impl Node

Source

pub fn name(&self) -> &str

This node’s dictionary-derived name, e.g. PID.5 or XPN.1.

Source

pub fn path(&self) -> &str

The er7 path that locates this node in the message, e.g. PID[1]-5[1].1.2. Pass it to crate::Message::get, crate::Message::set, or er7’s own query API.

The root node has an empty path: it is the message itself.

Source

pub fn kind(&self) -> Kind

Which level of the tree this node sits at.

Source

pub fn text(&self) -> &str

The decoded text of this node and everything beneath it, with structural delimiters intact.

Source

pub fn is_null(&self) -> bool

True when the sender wrote the HL7 explicit null "" here, meaning “clear this value” rather than “I have nothing to say”. The difference matters on the way to a database, so it survives parsing.

Source

pub fn is_leaf(&self) -> bool

True when this node has no children: a value, not a container.

Source

pub fn children(&self) -> &[Node]

This node’s children, in message order.

Source

pub fn child(&self, name: &str) -> Option<&Node>

The first child named name.

let message = hl7_2::parse("MSH|^~\\&|A||||1||ADT^A01|1|P|2.5\rPID|1||9||SMITH^JOHN")?;
let tree = message.tree();
let pid = tree.find("PID").unwrap();
assert_eq!(pid.child("PID.5").unwrap().child("XPN.2").unwrap().text(), "JOHN");
Source

pub fn children_named<'a>( &'a self, name: &'a str, ) -> impl Iterator<Item = &'a Node>

Every child named name, in order. This is how repetitions are read: a field sent as A~B is two PID.3 children, not one.

Source

pub fn find(&self, name: &str) -> Option<&Node>

The first node named name anywhere beneath this one, searched depth-first. Handy for reaching a segment without knowing which groups a structure nests it in.

Source

pub fn find_all<'a>(&'a self, name: &'a str) -> impl Iterator<Item = &'a Node>

Every node named name anywhere beneath this one, in message order.

Source

pub fn descendants(&self) -> Descendants<'_>

Every node beneath this one, depth-first, excluding this node.

Trait Implementations§

Source§

impl Clone for Node

Source§

fn clone(&self) -> Node

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Node

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Node

Source§

impl PartialEq for Node

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Node

Auto Trait Implementations§

§

impl Freeze for Node

§

impl RefUnwindSafe for Node

§

impl Send for Node

§

impl Sync for Node

§

impl Unpin for Node

§

impl UnsafeUnpin for Node

§

impl UnwindSafe for Node

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.