Struct UidRoot

pub struct UidRoot(/* private fields */);

The UidRoot struct represents a DICOM UID root that can be used as prefix for generating new UIDs during de-identification.

The UidRoot must follow DICOM UID format rules:

• Start with a digit 1-9
• Contain only numbers and dots

It also must not have more than 32 characters.

Example

use dicom_anonymization::config::UidRoot;

// Create a valid UID root
let uid_root = "1.2.840.123".parse::<UidRoot>().unwrap();

// Invalid UID root (not starting with 1-9)
let invalid = "0.1.2".parse::<UidRoot>();
assert!(invalid.is_err());

Implementations

impl UidRoot

pub fn new(uid_root: &str) -> Result<Self, UidRootError>

pub fn as_prefix(&self) -> String

Returns a string representation of the UidRoot suitable for use as a UID prefix.

If the UidRoot is not empty and does not end with a dot, a dot is appended. Whitespace is trimmed from both ends in all cases.

Returns

A String containing the formatted UID prefix

Trait Implementations

impl AsRef<str> for UidRoot

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UidRoot

fn clone(&self) -> UidRoot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UidRoot

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

Formats the value using the given formatter.

impl Default for UidRoot

fn default() -> Self

Default implementation for UidRoot that returns a UidRoot instance initialized with the default UID root value (i.e. "9999").

impl FromStr for UidRoot

type Err = UidRootError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for UidRoot

fn cmp(&self, other: &UidRoot) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UidRoot

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for UidRoot

fn partial_cmp(&self, other: &UidRoot) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for UidRoot

impl StructuralPartialEq for UidRoot