Struct dicom_encoding::text::SpecificCharacterSet

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

A descriptor for a specific character set, taking part in text encoding and decoding as per PS3.5 ch 6 6.1.

Example

Use from_code or one of the associated constants to create a character set. From there, use the TextCodec trait to encode and decode text.

use dicom_encoding::text::{SpecificCharacterSet, TextCodec};

let character_set = SpecificCharacterSet::from_code("ISO_IR 100").unwrap();
assert_eq!(character_set, SpecificCharacterSet::ISO_IR_100);

Implementations

impl SpecificCharacterSet

pub const ISO_IR_6: SpecificCharacterSet = _

ISO IR 6: The default character set, as defined by the DICOM standard.

pub const ISO_IR_100: SpecificCharacterSet = _

pub const ISO_IR_192: SpecificCharacterSet = _

ISO IR 192: UTF-8 encoding

pub fn from_code(code: &str) -> Option<Self>

Obtain the specific character set identified by the given code string.

Supported code strings include the possible values in the respective DICOM element (0008, 0005).

Example

use dicom_encoding::text::{SpecificCharacterSet, TextCodec};

let character_set = SpecificCharacterSet::from_code("ISO_IR 100").unwrap();
assert_eq!(character_set.name(), "ISO_IR 100");

Trait Implementations

impl Clone for SpecificCharacterSet

fn clone(&self) -> SpecificCharacterSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpecificCharacterSet

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

Formats the value using the given formatter.

impl Default for SpecificCharacterSet

fn default() -> SpecificCharacterSet

Returns the “default value” for a type.

impl PartialEq for SpecificCharacterSet

fn eq(&self, other: &SpecificCharacterSet) -> 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 TextCodec for SpecificCharacterSet

fn name(&self) -> Cow<'static, str>

Obtain the defined term (unique name) of the text encoding, which may be used as the value of a Specific Character Set (0008, 0005) element to refer to this codec.

fn decode(&self, text: &[u8]) -> Result<String, DecodeTextError>

Decode the given byte buffer as a single string. The resulting string may contain backslash characters (’') to delimit individual values, and should be split later on if required.

fn encode(&self, text: &str) -> Result<Vec<u8>, EncodeTextError>

Encode a text value into a byte vector. The input string can feature multiple text values by using the backslash character (’') as the value delimiter.

impl StructuralPartialEq for SpecificCharacterSet