Struct dicom_transfer_syntax_registry::TransferSyntax

pub struct TransferSyntax<A = Box<dyn DataRWAdapter<Box<dyn Read + 'static>, Box<dyn Write + 'static>, Reader = Box<dyn Read + 'static>, Writer = Box<dyn Write + 'static>> + 'static + Send + Sync>> { /* fields omitted */ }

A DICOM transfer syntax specifier. The data RW adapter A specifies custom codec capabilities when required.

Methods

impl<A> TransferSyntax<A>

pub const fn new(
    uid: &'static str,
    name: &'static str,
    byte_order: Endianness,
    explicit_vr: bool,
    codec: Codec<A>
) -> TransferSyntax<A>

pub const fn uid(&self) -> &'static str

Obtain this transfer syntax' unique identifier.

pub const fn name(&self) -> &'static str

Obtain the name of this transfer syntax.

pub const fn endianness(&self) -> Endianness

Obtain this transfer syntax' expected endianness.

pub fn codec(&self) -> &Codec<A>

Obtain this transfer syntax' codec specification.

pub fn fully_supported(&self) -> bool

Check whether this transfer syntax specifier provides a complete implementation.

pub fn unsupported(&self) -> bool

Check whether reading and writing of data sets is unsupported. If this is true, encoding and decoding will not be available.

pub fn unsupported_pixel_encapsulation(&self) -> bool

Check whether reading and writing the pixel data is unsupported. If this is true, encoding and decoding of the data set will still be possible, but the pixel data will only be available in its encapsulated form.

pub fn get_decoder(
    &self
) -> Option<Box<dyn Decode<Source = dyn Read + 'static> + 'static>>

Retrieve the appropriate data element decoder for this transfer syntax. Can yield none if decoding is not supported.

The resulting decoder does not consider pixel data encapsulation or data set compression rules. This means that the consumer of this method needs to adapt the reader before using the decoder.

pub fn get_encoder(
    &self
) -> Option<Box<dyn Encode<Writer = dyn Write + 'static> + 'static>>

Retrieve the appropriate data element encoder for this transfer syntax. Can yield none if encoding is not supported. The resulting encoder does not consider pixel data encapsulation or data set compression rules.

pub fn get_basic_decoder(&self) -> BasicDecoder

Obtain a dynamic basic decoder, based on this transfer syntax' expected endianness.

pub fn erased(
    self
) -> TransferSyntax<Box<dyn DataRWAdapter<Box<dyn Read + 'static>, Box<dyn Write + 'static>, Reader = Box<dyn Read + 'static>, Writer = Box<dyn Write + 'static>> + 'static + Send + Sync>> where
    A: Send + Sync + 'static + DataRWAdapter<Box<dyn Read + 'static>, Box<dyn Write + 'static>, Reader = Box<dyn Read + 'static>, Writer = Box<dyn Write + 'static>>, 

Type-erase the pixel data or data set codec.

Trait Implementations

impl Collect for TransferSyntax<Box<dyn DataRWAdapter<Box<dyn Read + 'static>, Box<dyn Write + 'static>, Reader = Box<dyn Read + 'static>, Writer = Box<dyn Write + 'static>> + 'static + Send + Sync>>

fn registry(
) -> &'static Registry<TransferSyntax<Box<dyn DataRWAdapter<Box<dyn Read + 'static>, Box<dyn Write + 'static>, Reader = Box<dyn Read + 'static>, Writer = Box<dyn Write + 'static>> + 'static + Send + Sync>>>

impl<A> Debug for TransferSyntax<A> where
    A: Debug, 

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

Formats the value using the given formatter.