Struct dicom_object::RootDicomObject

pub struct RootDicomObject<T> { /* fields omitted */ }

A root DICOM object contains additional meta information about the object

• (such as the DICOM file's meta header).

Methods

impl RootDicomObject<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> RootDicomObject<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 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.

impl<T> RootDicomObject<T>

pub fn meta(&self) -> &FileMetaTable

Retrieve the processed meta header table.

Trait Implementations

impl<T> DicomObject for RootDicomObject<T> where
    T: DicomObject, 

type Element = <T 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, T: 'a> DicomObject for &'a RootDicomObject<T> where
    T: DicomObject, 

type Element = <T 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<T: PartialEq> PartialEq<RootDicomObject<T>> for RootDicomObject<T>

fn eq(&self, other: &RootDicomObject<T>) -> bool

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

fn ne(&self, other: &RootDicomObject<T>) -> bool

This method tests for !=.

impl<T: Clone> Clone for RootDicomObject<T>

fn clone(&self) -> RootDicomObject<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> DerefMut for RootDicomObject<T>

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

Mutably dereferences the value.

impl<T> Deref for RootDicomObject<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Debug> Debug for RootDicomObject<T>

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

Formats the value using the given formatter.