Enum dicom_core::value::PrimitiveValue

pub enum PrimitiveValue {
    Empty,
    Strs(C<String>),
    Str(String),
    Tags(C<Tag>),
    U8(C<u8>),
    I16(C<i16>),
    U16(C<u16>),
    I32(C<i32>),
    U32(C<u32>),
    I64(C<i64>),
    U64(C<u64>),
    F32(C<f32>),
    F64(C<f64>),
    Date(C<NaiveDate>),
    DateTime(C<DateTime<FixedOffset>>),
    Time(C<NaiveTime>),
}

An enum representing a primitive value from a DICOM element. The result of decoding an element's data value may be one of the enumerated types depending on its content and value representation.

Variants

Empty

No data. Used for SQ (regardless of content) and any value of length 0.

Strs(C<String>)

A sequence of strings. Used for AE, AS, PN, SH, CS, LO, UI and UC. Can also be used for IS, SS, DS, DA, DT and TM when decoding with format preservation.

Str(String)

A single string. Used for ST, LT, UT and UR, which are never multi-valued.

Tags(C<Tag>)

A sequence of attribute tags. Used specifically for AT.

U8(C<u8>)

The value is a sequence of unsigned 16-bit integers. Used for OB and UN.

I16(C<i16>)

The value is a sequence of signed 16-bit integers. Used for SS.

U16(C<u16>)

A sequence of unsigned 168-bit integers. Used for US and OW.

I32(C<i32>)

A sequence of signed 32-bit integers. Used for SL and IS.

U32(C<u32>)

A sequence of unsigned 32-bit integers. Used for UL and OL.

I64(C<i64>)

A sequence of signed 64-bit integers. Used for SV.

U64(C<u64>)

A sequence of unsigned 64-bit integers. Used for UV and OV.

F32(C<f32>)

The value is a sequence of 32-bit floating point numbers. Used for OF and FL.

F64(C<f64>)

The value is a sequence of 64-bit floating point numbers. Used for OD and FD, DS.

Date(C<NaiveDate>)

A sequence of dates. Used for the DA representation.

DateTime(C<DateTime<FixedOffset>>)

A sequence of date-time values. Used for the DT representation.

Time(C<NaiveTime>)

A sequence of time values. Used for the TM representation.

Methods

impl PrimitiveValue

pub fn multiplicity(&self) -> u32

Obtain the number of individual elements. This number may not match the DICOM value multiplicity in some value representations.

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

Get a single string value. If it contains multiple strings, only the first one is returned.

pub fn strings(&self) -> Option<Vec<&str>>

Get a sequence of string values.

pub fn tag(&self) -> Option<Tag>

Get a single DICOM tag.

pub fn tags(&self) -> Option<&[Tag]>

Get a sequence of DICOM tags.

pub fn int64(&self) -> Option<i64>

Get a single 64-bit signed integer value.

pub fn uint64(&self) -> Option<u64>

Get a single 64-bit unsigned integer value.

pub fn int32(&self) -> Option<i32>

Get a single 32-bit signed integer value.

pub fn uint32(&self) -> Option<u32>

Get a single 32-bit unsigned integer value.

pub fn int16(&self) -> Option<i16>

Get a single 16-bit signed integer value.

pub fn uint16(&self) -> Option<u16>

Get a single 16-bit unsigned integer value.

pub fn uint8(&self) -> Option<u8>

Get a single 8-bit unsigned integer value.

pub fn float32(&self) -> Option<f32>

Get a single 32-bit floating point number value.

pub fn float64(&self) -> Option<f64>

Get a single 64-bit floating point number value.

pub fn calculate_byte_len(&self) -> usize

Determine the minimum number of bytes that this value would need to occupy in a DICOM file, without compression and without the header. As mandated by the standard, it is always even. The calculated number does not need to match the size of the original byte stream.

Trait Implementations

impl DicomValueType for PrimitiveValue

fn value_type(&self) -> ValueType

Retrieve the specific type of this value.

fn size(&self) -> Length

Retrieve the number of values contained.

fn is_empty(&self) -> bool

Check whether the value is empty (0 length).

impl<I> From<PrimitiveValue> for Value<I>

fn from(v: PrimitiveValue) -> Self

Performs the conversion.

impl PartialEq<PrimitiveValue> for PrimitiveValue

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

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

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

This method tests for !=.

impl Clone for PrimitiveValue

fn clone(&self) -> PrimitiveValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrimitiveValue

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

Formats the value using the given formatter.