Changes to DicomValue API and sequences #353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enet4
added
breaking change
- (change) rename `ValueType::Item` to `DataSetSequence` - this name describes what it represents more accurately - add `DataSetSequence` and `PixelFragmentSequence` - (change) replace `Value` variants `Sequence` and `PixelSequence` - use a tuple struct to a specific sequence type instead - Clarify that `new_sequence` and `new_pixel_sequence` only work in isolation - [parser][object][pixeldata][dump] propagate changes to other crates
- Vec<u8> is more common and more practical than [u8; 0] - Add alias `InMemFragment` - [object] redefine `InMemFragment` to use the definition from core - change PartialEq impl for DataSetSequence - disregards recorded length
- affects to_str(), to_raw_str(), and to_bytes() - ConvertValueError makes more sense here - (change) remove deprecated methods to_clean_str() - propagate error type change to data element types - increase module test coverage
Enet4
force-pushed
the
change/core/value-seq
branch
from
58e00b4 to
5147830
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes some usability improvements to the core value API. The main changes here are the enum
DicomValue<I, P>now has a different default for the type parameterP(to the same value used by in-memory DICOM objects indicom_object), and it uses struct definitions for data set sequences and pixel data fragment sequence, instead of declaring struct variants in the enum.I also took this opportunity to remove deprecated functions, adjust the error types returned in some methods, and increase test coverage a bit.
Summary
DicomValuesequence variant fields to their own independent types (DataSetSequenceandPixelFragmentSequence)PtoVec<u8>(also aliased toInMemFragment)Value::to_str,Value::to_raw_str,Value::to_bytesCastValueErrortoConvertValueErrorPartialEqforDicomValuebetween data set items: recorded length is ignored, only items are compared.