Enum dicom_encoding::transfer_syntax::Codec

pub enum Codec<D, R, W> {
    None,
    EncapsulatedPixelData(Option<R>, Option<W>),
    Dataset(Option<D>),
}

A description and possible implementation regarding the encoding and decoding requirements of a transfer syntax. This is also used as a means to describe whether pixel data is encapsulated and whether this implementation supports decoding and/or encoding it.

Type parameters

• D should implement DataRWAdapter and defines how one should read and write DICOM data sets, such as in the case for deflated data. When no special considerations for data set reading and writing are necessary, this can be set to NeverAdapter.
• R should implement PixelDataReader, and enables programs to convert encapsulated pixel data fragments into native pixel data.
• W should implement PixelDataWriter, and enables programs to convert native pixel data into encapsulated pixel data.

Variants

None

No codec is required for this transfer syntax.

Pixel data, if any, should be in its native, unencapsulated format.

EncapsulatedPixelData(Option<R>, Option<W>)

Pixel data for this transfer syntax is encapsulated and likely subjected to a specific encoding process. The first part of the tuple struct contains the pixel data decoder, whereas the second item is for the pixel data encoder.

Decoding of the pixel data is not supported if the decoder is None. In this case, the program should still be able to parse DICOM data sets and fetch the pixel data in its encapsulated form.

Dataset(Option<D>)

A custom data set codec is required for reading and writing data sets.

If the item in the tuple struct is None, then no reading and writing whatsoever is supported. This could be used by a stub of Deflated Explicit VR Little Endian, for example.

Trait Implementations

impl<D: Clone, R: Clone, W: Clone> Clone for Codec<D, R, W>

fn clone(&self) -> Codec<D, R, W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug, R: Debug, W: Debug> Debug for Codec<D, R, W>

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

Formats the value using the given formatter.

impl<D: PartialEq, R: PartialEq, W: PartialEq> PartialEq for Codec<D, R, W>

fn eq(&self, other: &Codec<D, R, W>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D, R, W> StructuralPartialEq for Codec<D, R, W>