Merge #43

43: Closing #25: toplevel module r=wokket a=wokket

Moved the structs into the top level for #25 .  Note that this is a breaking change!

Co-authored-by: Tim Thompson <[email protected]>

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.6.0
+- Breaking Change ([#25](https://github.com/wokket/rust-hl7/issues/25)): Moved the core structs to the top-level module to avoid the noisy using statements.
+
 ## 0.5.0
  - Add `query` functions to replace the string based `Index` impls in the version version.  These are functionally identical to the string `Index` implementations, but avoid some lifetime issues (returning `&&str`) and have visible documentation.
  - Add `EscapeSequence` struct to support decoding [escape sequences](https://www.lyniate.com/knowledge-hub/hl7-escape-sequences/) back to their original values.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rust-hl7"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["wokket <[email protected]>"]
 edition = "2018"
 description = "HL7 Parser and object builder? query'er? - experimental only at any rate"

benches/decoder.rs

@@ -1,5 +1,5 @@
 use criterion::{criterion_group, criterion_main, Criterion};
-use rusthl7::{escape_sequence::*, separators::Separators};
+use rusthl7::{EscapeSequence, Separators};
 
 // Note that we;re calkling decode on a whole message here, although it would normally be on an individual field...
 // this is just to make it work a bit harder on a larger dataset, not because it makes sense in a HL7 sense

benches/simple_parse.rs

@@ -1,5 +1,5 @@
 use criterion::{criterion_group, criterion_main, Criterion};
-use rusthl7::message::*;
+use rusthl7::Message;
 use std::convert::TryFrom;
 
 fn get_sample_message() -> &'static str {

examples/demo.rs

@@ -2,7 +2,7 @@
  A short example demonstrating one way to use this library for HL7 processing.
 */
 
-use rusthl7::{escape_sequence::EscapeSequence, message::Message};
+use rusthl7::{EscapeSequence, Message};
 use std::{convert::TryFrom, error::Error};
 
 fn main() -> Result<(), Box<dyn Error>> {

examples/typed_segment.rs

@@ -2,7 +2,7 @@
  A short example demonstrating one way to use this library for HL7 processing.
 */
 
-use rusthl7::{fields::Field, message::Message, separators::Separators, Hl7ParseError};
+use rusthl7::{Field, Hl7ParseError, Message, Separators};
 use std::{convert::TryFrom, error::Error, fmt::Display};
 
 /// The most important Segment, almost all HL7 messages have an MSH (MLLP simple ack I'm looking at you).

src/escape_sequence.rs

@@ -10,8 +10,8 @@ use std::borrow::Cow;
 ///
 /// ## Example:
 /// ```
-/// # use rusthl7::escape_sequence::EscapeSequence;
-/// # use rusthl7::separators::Separators;
+/// # use rusthl7::EscapeSequence;
+/// # use rusthl7::Separators;
 /// let delims = Separators::default();
 /// let decoder = EscapeSequence::new(delims);
 /// let hl7_field_value = r#"Obstetrician \T\ Gynaecologist"#;

src/lib.rs

@@ -10,11 +10,19 @@ This crate tries to provide the tools to build HL7 systems without dictating _ho
 
 */
 
-pub mod escape_sequence;
-pub mod fields;
-pub mod message;
-pub mod segments;
-pub mod separators;
+mod escape_sequence;
+mod fields;
+mod message;
+mod segments;
+mod separators;
+
+// re-exports to simplify namespacing (#25)
+pub use fields::Field;
+pub use message::Message;
+pub use segments::Segment;
+
+pub use escape_sequence::EscapeSequence;
+pub use separators::Separators;
 
 #[derive(Debug, thiserror::Error)]
 pub enum Hl7ParseError {

src/message.rs

@@ -55,7 +55,7 @@ impl<'a> Message<'a> {
     /// ## Example:
     /// ```
     /// # use rusthl7::Hl7ParseError;
-    /// # use rusthl7::message::Message;
+    /// # use rusthl7::Message;
     /// # use std::convert::TryFrom;
     /// # fn main() -> Result<(), Hl7ParseError> {
     /// let source = "MSH|^~\\&|GHH LAB|ELAB-3|GHH OE|BLDG4|200202150930||ORU^R01|CNTRL-3456|P|2.4";
@@ -191,7 +191,7 @@ impl<'a> Clone for Message<'a> {
     /// ## Example:
     /// ```
     /// # use rusthl7::Hl7ParseError;
-    /// # use rusthl7::message::Message;
+    /// # use rusthl7::Message;
     /// # use std::convert::TryFrom;
     /// # fn main() -> Result<(), Hl7ParseError> {
     /// let m = Message::try_from("MSH|^~\\&|GHH LAB|ELAB-3|GHH OE|BLDG4|200202150930||ORU^R01|CNTRL-3456|P|2.4")?;

src/segments.rs

@@ -165,7 +165,7 @@ impl<'a> Index<String> for Segment<'a> {
 
 #[cfg(test)]
 mod tests {
-    use crate::{message::Message, segments::*, separators::Separators, Hl7ParseError};
+    use crate::Message;
     use std::convert::TryFrom;
 
     #[test]