Struct dicom_object::FileDicomObject

pub struct FileDicomObject<O> { /* fields omitted */ }

A root DICOM object retrieved from a standard DICOM file, containing additional information from the file meta group in a separate table value.

Implementations

impl FileDicomObject<InMemDicomObject<StandardDataDictionary>>

pub fn open_file<P: AsRef<Path>>(path: P) -> Result<Self>

Create a DICOM object by reading from a file.

This function assumes the standard file encoding structure: 128-byte preamble, file meta group, and the rest of the data set.

pub fn from_reader<S>(src: S) -> Result<Self> where
    S: Read, 

Create a DICOM object by reading from a byte source.

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

impl<D> FileDicomObject<InMemDicomObject<D>> where
    D: DataDictionary,
    D: Clone, 

pub fn new_empty_with_dict_and_meta(dict: D, meta: FileMetaTable) -> Self

Create a new empty object, using the given dictionary and file meta table.

pub fn open_file_with_dict<P: AsRef<Path>>(path: P, dict: D) -> Result<Self>

Create a DICOM object by reading from a file.

This function assumes the standard file encoding structure: 128-byte preamble, file meta group, and the rest of the data set.

pub fn open_file_with<P: AsRef<Path>, R>(
    path: P,
    dict: D,
    ts_index: R
) -> Result<Self> where
    P: AsRef<Path>,
    R: TransferSyntaxIndex, 

Create a DICOM object by reading from a file.

This function assumes the standard file encoding structure: 128-byte preamble, file meta group, and the rest of the data set.

This function allows you to choose a different transfer syntax index, but its use is only advised when the built-in transfer syntax registry is insufficient. Otherwise, please use open_file_with_dict instead.

pub fn from_reader_with_dict<S>(src: S, dict: D) -> Result<Self> where
    S: Read, 

Create a DICOM object by reading from a byte source.

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

pub fn from_reader_with<'s, S: 's, R>(
    src: S,
    dict: D,
    ts_index: R
) -> Result<Self> where
    S: Read,
    R: TransferSyntaxIndex, 

Create a DICOM object by reading from a byte source.

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

This function allows you to choose a different transfer syntax index, but its use is only advised when the built-in transfer syntax registry is insufficient. Otherwise, please use from_reader_with_dict instead.

impl FileDicomObject<InMemDicomObject<StandardDataDictionary>>

pub fn new_empty_with_meta(meta: FileMetaTable) -> Self

Create a new empty object, using the given file meta table.

impl<O> FileDicomObject<O>

pub fn meta(&self) -> &FileMetaTable

Retrieve the processed meta header table.

pub fn into_inner(self) -> O

Retrieve the inner DICOM object structure, discarding the meta table.

impl<O> FileDicomObject<O> where
    &'a O: IntoTokens, 

pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Write the entire object as a DICOM file into the given file path. Preamble, magic code, and file meta group will be included before the inner object.

pub fn write_all<W: Write>(&self, to: W) -> Result<()>

Write the entire object as a DICOM file into the given writer. Preamble, magic code, and file meta group will be included before the inner object.

pub fn write_meta<W: Write>(&self, to: W) -> Result<()>

Write the file meta group set into the given writer.

This is equivalent to self.meta().write(to).

pub fn write_dataset<W: Write>(&self, to: W) -> Result<()>

Write the inner data set into the given writer, without preamble, magic code, nor file meta group.

The transfer syntax is selected from the file meta table.

Trait Implementations

impl<O: Clone> Clone for FileDicomObject<O>

fn clone(&self) -> FileDicomObject<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug> Debug for FileDicomObject<O>

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

Formats the value using the given formatter.

impl<O> Deref for FileDicomObject<O>

type Target = O

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<O> DerefMut for FileDicomObject<O>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<O> DicomObject for FileDicomObject<O> where
    O: DicomObject, 

type Element = <O as DicomObject>::Element

fn element(&self, tag: Tag) -> Result<Self::Element>

Retrieve a particular DICOM element by its tag.

fn element_by_name(&self, name: &str) -> Result<Self::Element>

Retrieve a particular DICOM element by its name.

fn meta(&self) -> Option<&FileMetaTable>

Retrieve the processed meta information table, if available.

impl<'a, O: 'a> DicomObject for &'a FileDicomObject<O> where
    O: DicomObject, 

type Element = <O as DicomObject>::Element

fn element(&self, tag: Tag) -> Result<Self::Element>

Retrieve a particular DICOM element by its tag.

fn element_by_name(&self, name: &str) -> Result<Self::Element>

Retrieve a particular DICOM element by its name.

fn meta(&self) -> Option<&FileMetaTable>

Retrieve the processed meta information table, if available.

impl<O> IntoIterator for FileDicomObject<O> where
    O: IntoIterator, 

type Item = <O as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <O as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<O: PartialEq> PartialEq<FileDicomObject<O>> for FileDicomObject<O>

fn eq(&self, other: &FileDicomObject<O>) -> bool

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

fn ne(&self, other: &FileDicomObject<O>) -> bool

This method tests for !=.

impl<O> StructuralPartialEq for FileDicomObject<O>