Struct dicom_parser::stateful::decode::StatefulDecoder

pub struct StatefulDecoder<D, BD, S, TC> { /* fields omitted */ }

A stateful abstraction for the full DICOM content reading process. This type encapsulates the necessary codecs in order to be as autonomous as possible in the DICOM content reading process. S is the generic parameter type for the original source, D is the parameter type that the decoder interprets as, whereas DB is the parameter type for the basic decoder. TC defines the text codec used underneath.

Implementations

impl<'s> StatefulDecoder<Box<dyn DecodeFrom<dyn Read + 's> + 'static>, BasicDecoder, Box<dyn Read + 's>, Box<dyn TextCodec + 'static>>

pub fn new_with<S: 's>(
    from: S,
    ts: &TransferSyntax,
    charset: SpecificCharacterSet
) -> Result<Self> where
    S: Read, 

Create a new DICOM parser for the given transfer syntax and character set.

impl<S> StatefulDecoder<ExplicitVRLittleEndianDecoder, LittleEndianBasicDecoder, S, DefaultCharacterSetCodec> where
    S: Read, 

pub fn file_header_parser(from: S) -> Self

Create a new DICOM stateful decoder for reading the file meta header, which is always in Explicit VR Little Endian.

impl<D, BD, S, TC> StatefulDecoder<D, BD, S, TC>

pub fn new(
    from: S,
    decoder: D,
    basic: BD,
    text: TC
) -> StatefulDecoder<D, BD, S, TC>

Create a new DICOM stateful decoder from its parts.

Trait Implementations

impl<D: Debug, BD: Debug, S: Debug, TC: Debug> Debug for StatefulDecoder<D, BD, S, TC>

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

Formats the value using the given formatter.

impl<S, T: ?Sized, D, BD> StatefulDecode for StatefulDecoder<D, BD, S, DynamicTextCodec> where
    D: DecodeFrom<T>,
    BD: BasicDecode,
    S: DerefMut<Target = T> + Read,
    T: Read, 

type Reader = S

fn decode_header(&mut self) -> Result<DataElementHeader>

Same as Decode::decode_header over the bound source.

fn decode_item_header(&mut self) -> Result<SequenceItemHeader>

Same as Decode::decode_item_header over the bound source.

fn read_value(&mut self, header: &DataElementHeader) -> Result<PrimitiveValue>

Eagerly read the following data in the source as a primitive data value. When reading values in text form, a conversion to a more maleable type is attempted. Namely, numbers in text form (IS, DS) are converted to the corresponding binary number types, and date/time instances are decoded into binary date/time objects of types defined in the chrono crate. To avoid this conversion, see read_value_preserved.

fn read_value_preserved(
    &mut self,
    header: &DataElementHeader
) -> Result<PrimitiveValue>

Eagerly read the following data in the source as a primitive data value. Unlike read_value, this method will preserve the DICOM value's original format: numbers saved as text, as well as dates and times, are read as strings.

fn read_value_bytes(
    &mut self,
    header: &DataElementHeader
) -> Result<PrimitiveValue>

Eagerly read the following data in the source as a primitive data value as bytes, regardless of its value representation.

fn value_reader(
    &mut self,
    header: &DataElementHeader
) -> Result<Take<&mut Self::Reader>>

Obtain a reader which outlines the primitive value data from the given source.

fn read_bytes(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact amount of bytes to fill the buffer.

fn bytes_read(&self) -> u64

Retrieve the exact number of bytes read so far by the stateful decoder.