Struct dicom_object::meta::FileMetaTable

pub struct FileMetaTable {
    pub information_group_length: u32,
    pub information_version: [u8; 2],
    pub media_storage_sop_class_uid: String,
    pub media_storage_sop_instance_uid: String,
    pub transfer_syntax: String,
    pub implementation_class_uid: String,
    pub implementation_version_name: Option<String>,
    pub source_application_entity_title: Option<String>,
    pub sending_application_entity_title: Option<String>,
    pub receiving_application_entity_title: Option<String>,
    pub private_information_creator_uid: Option<String>,
    pub private_information: Option<Vec<u8>>,
}

DICOM File Meta Information Table.

This data type contains the relevant parts of the file meta information table, as specified in part 6, chapter 7 of the standard.

Creating a new file meta table from scratch is more easily done using a FileMetaTableBuilder. When modifying the struct’s public fields, it is possible to update the information group length through method update_information_group_length.

Fields

information_group_length: u32

File Meta Information Group Length

information_version: [u8; 2]

File Meta Information Version

media_storage_sop_class_uid: String

Media Storage SOP Class UID

media_storage_sop_instance_uid: String

Media Storage SOP Instance UID

transfer_syntax: String

Transfer Syntax UID

implementation_class_uid: String

Implementation Class UID

implementation_version_name: Option<String>

Implementation Version Name

source_application_entity_title: Option<String>

Source Application Entity Title

sending_application_entity_title: Option<String>

Sending Application Entity Title

receiving_application_entity_title: Option<String>

Receiving Application Entity Title

private_information_creator_uid: Option<String>

Private Information Creator UID

private_information: Option<Vec<u8>>

Private Information

Implementations

impl FileMetaTable

pub fn from_reader<R: Read>(file: R) -> Result<Self, Error>

Construct a file meta group table by parsing a DICOM data set from a reader.

pub fn transfer_syntax(&self) -> &str

Getter for the transfer syntax UID, with trailing characters already excluded.

pub fn media_storage_sop_instance_uid(&self) -> &str

Getter for the media storage SOP instance UID, with trailing characters already excluded.

pub fn media_storage_sop_class_uid(&self) -> &str

Getter for the media storage SOP class UID, with trailing characters already excluded.

pub fn implementation_class_uid(&self) -> &str

Getter for the implementation class UID, with trailing characters already excluded.

pub fn private_information_creator_uid(&self) -> Option<&str>

Getter for the private information creator UID, with trailing characters already excluded.

pub fn set_transfer_syntax<D, P>(&mut self, ts: &TransferSyntax<D, P>)

Set the file meta table’s transfer syntax according to the given transfer syntax descriptor.

Extra padding to even length is trimmed.

Note that the field information_group_length is not updated to consider the length of the new transfer syntax. Should you wish to keep the field up to date, call update_information_group_length afterwards.

pub fn update_information_group_length(&mut self)

Calculate the expected file meta group length according to the file meta attributes currently set, and assign it to the field information_group_length.

pub fn into_element_iter( self ) -> impl Iterator<Item = DataElement<EmptyObject, [u8; 0]>>

Create an iterator over the defined data elements of the file meta group, consuming the file meta table.

See to_element_iter for a version which copies the element from the table.

pub fn to_element_iter( &self ) -> impl Iterator<Item = DataElement<EmptyObject, [u8; 0]>> + '_

Create an iterator of data elements copied from the file meta group.

See into_element_iter for a version which consumes the table.

pub fn write<W: Write>(&self, writer: W) -> Result<(), Error>

Trait Implementations

impl ApplyOp for FileMetaTable

fn apply(&mut self, op: AttributeOp) -> ApplyResult

Apply the given attribute operation on this file meta information table.

See the dicom_core::ops module for more information.

type Err = ApplyError

The operation error type

impl Clone for FileMetaTable

fn clone(&self) -> FileMetaTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetaTable

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

Formats the value using the given formatter.

impl PartialEq for FileMetaTable

fn eq(&self, other: &FileMetaTable) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FileMetaTable