Skip to content

refactor: make hl7v2-network a compatibility shim #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EffortlessSteven merged 1 commit into from
May 7, 2026
Merged

refactor: make hl7v2-network a compatibility shim #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 1 addition & 20 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 6 additions & 19 deletions crates/hl7v2-network/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,15 @@ keywords.workspace = true
categories = ["network-programming", "asynchronous"]

[dependencies]
# Core HL7v2 dependencies
hl7v2-model = { version = "1.2.0", path = "../hl7v2-model" }
hl7v2-parser = { version = "1.2.0", path = "../hl7v2-parser" }
hl7v2-writer = { version = "1.2.0", path = "../hl7v2-writer" }

# Async runtime and networking
tokio = { workspace = true, features = ["net", "io-util", "time", "macros", "rt", "sync"] }
tokio-util = { version = "0.7.18", features = ["codec"] }
bytes = "1.11.1"
futures = "0.3.32"

# Optional TLS support
rustls = { version = "0.23.37", optional = true, default-features = false, features = ["ring"] }
tokio-rustls = { version = "0.26.4", optional = true, default-features = false, features = ["ring"] }
hl7v2 = { version = "1.2.0", path = "../hl7v2", default-features = false, features = [
"network",
] }

[features]
default = []
tls = ["rustls", "tokio-rustls"]
tls = []

[dev-dependencies]
tokio = { workspace = true, features = ["macros", "rt-multi-thread", "time", "net", "io-util"] }
hl7v2-test-utils = { path = "../hl7v2-test-utils" }
proptest = "1.6"
tokio-test = "0.4"

tokio-util = { workspace = true, features = ["codec"] }
bytes = { workspace = true }
3 changes: 2 additions & 1 deletion crates/hl7v2-network/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# hl7v2-network

TCP and MLLP based network communication for HL7 v2.
Deprecated compatibility crate for TCP and MLLP based network communication.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Hyphenate "MLLP-based" (compound modifier).

-Deprecated compatibility crate for TCP and MLLP based network communication.
+Deprecated compatibility crate for TCP and MLLP-based network communication.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Deprecated compatibility crate for TCP and MLLP based network communication.
Deprecated compatibility crate for TCP and MLLP-based network communication.
🧰 Tools
🪛 LanguageTool

[grammar] ~3-~3: Use a hyphen to join words.
Context: ...ted compatibility crate for TCP and MLLP based network communication. Use `hl7v2:...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@crates/hl7v2-network/README.md` at line 3, Summary: The README uses "MLLP
based" as a compound modifier and should be hyphenated. Fix: update the sentence
containing "TCP and MLLP based network communication." (search for that exact
string in the README or the line under the crate description) and change it to
"TCP and MLLP-based network communication." to correctly hyphenate the compound
modifier "MLLP-based".

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Hyphenate compound modifier: "MLLP-based".

MLLP based acting as a compound adjective before network communication should be hyphenated.

-Deprecated compatibility crate for TCP and MLLP based network communication.
+Deprecated compatibility crate for TCP and MLLP-based network communication.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Deprecated compatibility crate for TCP and MLLP based network communication.
Deprecated compatibility crate for TCP and MLLP-based network communication.
🧰 Tools
🪛 LanguageTool

[grammar] ~3-~3: Use a hyphen to join words.
Context: ...ted compatibility crate for TCP and MLLP based network communication. Use `hl7v2:...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@crates/hl7v2-network/README.md` at line 3, Update the README phrase "MLLP
based" to the hyphenated compound modifier "MLLP-based" so the sentence reads
"Deprecated compatibility crate for TCP and MLLP-based network communication";
locate and replace the unhyphenated instance in the README content where the
crate description is defined.

Use `hl7v2::transport::network` for new Rust code.

## Usage

Expand Down
279 changes: 0 additions & 279 deletions crates/hl7v2-network/src/client.rs
View file
Open in desktop

This file was deleted.

Loading
Loading