Struct dicom_core::value::person_name::PersonName

pub struct PersonName<'a> { /* private fields */ }

A DICOM Person Name (PN value representation).

Values of this type keep family name, given name, middle name, prefix and suffix as borrowed values. All name components are optional.

Example

A value of type PersonName can be obtained either by parsing a DICOM formatted string via from_text or by using the builder API.

let dr_seuss: PersonName = PersonName::from_text("Geisel^Theodor^Seuss^Dr.");
assert_eq!(&dr_seuss.to_string(), "Dr. Theodor Seuss Geisel");
assert_eq!(dr_seuss.prefix(), Some("Dr."));
assert_eq!(dr_seuss.given(), Some("Theodor"));

Implementations

impl<'a> PersonName<'a>

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

Retrieve PersonName prefix

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

Retrieve PersonName suffix

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

Retrieve family name from PersonName

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

Retrieve given name from PersonName

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

Retrieve middle name from PersonName

pub fn to_dicom_string(&self) -> String

Convert the person name into a DICOM formatted string.

Name components are interspersed with a '^' separator. Leading null components produce a separator, while trailing components do not.

pub fn from_text(slice: &'a str) -> PersonName<'a>

Obtains a person name by interpreting slice as a DICOM formatted string.

The DICOM string representation is split by the '^' separator into its respective components. When passing a text value to this function, ensure that it contains a single DICOM formatted name.

pub fn builder() -> PersonNameBuilder<'a>

Retrieve a builder for a person name.

See PersonNameBuilder for more information.

Trait Implementations

impl<'a> Clone for PersonName<'a>

fn clone(&self) -> PersonName<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PersonName<'a>

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

Formats the value using the given formatter.

impl Display for PersonName<'_>

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

Formats the value using the given formatter.

impl<'a> From<&mut PersonNameBuilder<'a>> for PersonName<'a>

fn from(builder: &mut PersonNameBuilder<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PersonName<'a>> for PrimitiveValue

fn from(p: PersonName<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<PersonNameBuilder<'a>> for PersonName<'a>

fn from(builder: PersonNameBuilder<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for PersonName<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for PersonName<'a>

fn eq(&self, other: &PersonName<'a>) -> 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<'a> Copy for PersonName<'a>

impl<'a> Eq for PersonName<'a>

impl<'a> StructuralPartialEq for PersonName<'a>