Struct CharacterStringRef 

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

A CharacterString’s contents, borrowed from the octets they were decoded from: the character-set octet, then the string in that character set (Clause 20.2.9).

decode checks the contents’ structure as every decoder of a CharacterString does (#1778): a character set the clause defines, valid UTF-8, a DBCS string’s two-octet code page, and whole UCS-2 and UCS-4 characters that are Unicode scalar values. So as_str borrows UTF-8 contents as a &str; contents in another character set are carried as they are, for the caller to convert.

use bacnet_encoding::primitives::{charset, CharacterStringRef};

let text = CharacterStringRef::decode(&[charset::UTF8, b'A', b'V'])?;
assert_eq!((text.charset(), text.as_str()), (charset::UTF8, Some("AV")));

let latin1 = CharacterStringRef::decode(&[charset::ISO_8859_1, 0xE9])?;
assert_eq!((latin1.as_str(), latin1.bytes()), (None, &[0xE9][..]));

Implementations

impl<'a> CharacterStringRef<'a>

pub fn decode(contents: &'a [u8]) -> Result<Self, Error>

Read CharacterString contents, refusing the malformed structures the type’s docs list, each DecodingKind::InvalidEncoding at an offset into contents: no or a reserved character-set octet, invalid UTF-8, a DBCS string without its code page, and broken UCS-2 or UCS-4.

pub fn charset(&self) -> u8

The character set, one of charset.

pub fn bytes(&self) -> &'a [u8]

The string’s octets in its character set, after the character-set octet.

pub fn contents(&self) -> &'a [u8]

The complete contents: the character-set octet and the string.

pub fn as_str(&self) -> Option<&'a str>

The string, when it is UTF-8; None for any other character set.

Trait Implementations

impl<'a> Clone for CharacterStringRef<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CharacterStringRef<'a>

impl<'a> Debug for CharacterStringRef<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for CharacterStringRef<'a>

impl<'a> Hash for CharacterStringRef<'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 CharacterStringRef<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for CharacterStringRef<'a>