Skip to content

[ul] Revise documentation and doctests around TLS support#741

Merged
Enet4 merged 4 commits intomasterfrom
chore/ul/tweak-doctests
Mar 5, 2026
Merged

[ul] Revise documentation and doctests around TLS support#741
Enet4 merged 4 commits intomasterfrom
chore/ul/tweak-doctests

Conversation

@Enet4
Copy link
Copy Markdown
Owner

@Enet4 Enet4 commented Feb 19, 2026

  • Add a paragraph on TLS support at root crate level
  • Make it so that client and server doctest examples are checked and syntax highlighted
    • use std::fs::read to fetch the necessary files
    • fix these doctests so that they compile regardless of Cargo features

@Enet4 Enet4 force-pushed the chore/ul/tweak-doctests branch from 28b8759 to b46510b Compare February 26, 2026 10:34
@Enet4 Enet4 added A-lib Area: library C-ul Crate: dicom-ul labels Feb 26, 2026
@Enet4 Enet4 marked this pull request as ready for review February 26, 2026 12:01
Enet4 added 4 commits March 1, 2026 14:28
- Add a paragraph on TLS support at root crate level
- Make it so that client and server doctest examples are checked and syntax highlighted
   - use hidden comment trickery to show the same code
   - fix these doctests so that they compile regardless of Cargo features
- Drop comment trickery and load crt/key files at runtime instead
- Reorganize imports
- show imports of `ServerAssociation` and `ServerAssociationOptions`
- try retrieving associaton in the end
- show imports of `ClientAssociation` and `ClientAssociationOptions`
- fix `establish` call by using `establish_with_tls`
- use SOP Class constant VERIFICATION
  for clarity and better guidance
@Enet4 Enet4 force-pushed the chore/ul/tweak-doctests branch from d931d57 to aa217bf Compare March 1, 2026 14:28
@Enet4 Enet4 added this to the DICOM-rs 0.9.1 milestone Mar 4, 2026
@Enet4 Enet4 merged commit 95fa6f7 into master Mar 5, 2026
5 checks passed
@Enet4 Enet4 deleted the chore/ul/tweak-doctests branch March 5, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-lib Area: library C-ul Crate: dicom-ul

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant