Struct dicom_object::file::OpenFileOptions

#[non_exhaustive]
pub struct OpenFileOptions<D = StandardDataDictionary, T = TransferSyntaxRegistry> { /* private fields */ }

A builder type for opening a DICOM file with additional options.

This builder exposes additional properties to configure the reading of a DICOM file.

Example

Create a OpenFileOptions, call adaptor methods in a chain, and finish the operation with either open_file() or from_reader().

let file = OpenFileOptions::new()
    .read_until(dicom_dictionary_std::tags::PIXEL_DATA)
    .open_file("path/to/file.dcm")?;

Implementations

impl OpenFileOptions

pub fn new() -> Self

impl<D, T> OpenFileOptions<D, T>

pub fn read_until(self, tag: Tag) -> Self

Set the operation to read only until the given tag is found.

The reading process ends immediately after this tag, or any other tag that is next in the standard DICOM tag ordering, is found in the object’s root data set. An element with the exact tag will be excluded from the output.

pub fn read_all(self) -> Self

Set the operation to read all elements of the data set to the end.

This is the default behavior.

pub fn read_preamble(self, option: ReadPreamble) -> Self

Set whether to read the 128-byte DICOM file preamble.

pub fn tranfer_syntax_index<Tr>(self, ts_index: Tr) -> OpenFileOptions<D, Tr>

where Tr: TransferSyntaxIndex,

Set the transfer syntax index to use when reading the file.

pub fn dictionary<Di>(self, dict: Di) -> OpenFileOptions<Di, T>

where Di: DataDictionary + Clone,

Set the data element dictionary to use when reading the file.

pub fn open_file<P>(self, path: P) -> Result<DefaultDicomObject<D>>

where P: AsRef<Path>, D: DataDictionary + Clone, T: TransferSyntaxIndex,

Open the file at the given path.

pub fn from_reader<R>(self, from: R) -> Result<DefaultDicomObject<D>>

where R: Read, D: DataDictionary + Clone, T: TransferSyntaxIndex,

Obtain a DICOM object by reading from a byte source.

This method assumes the standard file encoding structure without the preamble: file meta group, followed by the rest of the data set.

Trait Implementations

impl<D: Clone, T: Clone> Clone for OpenFileOptions<D, T>

fn clone(&self) -> OpenFileOptions<D, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug, T: Debug> Debug for OpenFileOptions<D, T>

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

Formats the value using the given formatter.

impl<D: Default, T: Default> Default for OpenFileOptions<D, T>

fn default() -> OpenFileOptions<D, T>

Returns the “default value” for a type.