Struct bcder::string::RestrictedString

pub struct RestrictedString<L: CharSet> { /* private fields */ }

A generic restricted character string.

Restricted character strings essentially are a sequence of characters from a specific character set mapped into a sequence of octets. In BER, these are in fact encoded just like an OctetString with a different tag. Consequently, this type is a wrapper around OctetString that makes sure that the sequence of octets is correctly encoded for the given character set.

As usual, you can parse a restricted character string from encoded data by way of the take_from and from_content methods. Alternatively, you can create a new value from a String or str via the from_string and from_str associated functions.

Conversely, a restricted character string can be converted into a string by way of the to_string and to_str methods.

In addition, the restricted character string mirrors the standard library’s string types by dereffing to OctetString and using the octet string’s iterators. In addition, the chars method provides an iterator over the characters encoded in the string.

Implementations

impl<L: CharSet> RestrictedString<L>

pub fn new(os: OctetString) -> Result<Self, CharSetError>

Creates a new character string from an octet string.

If the octet string contains octet sequences that are not valid for the character set, an appropriate error will be returned.

pub fn from_string(s: String) -> Result<Self, CharSetError>

Creates a new character string from a String.

If the string’s internal representation is identical to the encoding of restricted character string, the string will be reused and no allocation occurs. Otherwise, a new bytes value is created.

If the string cannot be encoded in the character set, an error is returned.

pub fn chars(&self) -> RestrictedStringChars<'_, L>

Returns an iterator over the character in the character string.

pub fn into_bytes(self) -> Bytes

Converts the string into its underlying bytes.

Note that the bytes value will contain the raw octets of the string which are not necessarily a valid Rust string.

impl<L: CharSet> RestrictedString<L>

Decoding and Encoding

pub fn take_from<S: Source>(
    cons: &mut Constructed<'_, S>
) -> Result<Self, DecodeError<S::Error>>

Takes a single character set value from constructed value content.

If there is no next value, if the next value does not have the natural tag appropriate for this character set implementation, or if it does not contain a correctly encoded character string, a malformed error is returned.

pub fn from_content<S: Source>(
    content: &mut Content<'_, S>
) -> Result<Self, DecodeError<S::Error>>

Takes a character set from content.

pub fn encode(self) -> impl Values

Returns a value encoder for the character string with the natural tag.

pub fn encode_as(self, tag: Tag) -> impl Values

Returns a value encoder for the character string with the given tag.

pub fn encode_ref(&self) -> impl Values + '_

Returns a value encoder for the character string with the natural tag.

pub fn encode_ref_as(&self, tag: Tag) -> impl Values + '_

Returns a value encoder for the character string with the given tag.

Methods from Deref<Target = OctetString>

pub fn iter(&self) -> OctetStringIter<'_>

Returns an iterator over the parts of the octet string.

The iterator will produce &[u8] which, when appended produce the complete content of the octet string.

pub fn octets(&self) -> OctetStringOctets<'_>

Returns an iterator over the individual octets of the string.

pub fn as_slice(&self) -> Option<&[u8]>

Returns a reference to the complete content if possible.

The method will return a bytes slice of the content if the octet string was encoded as a single primitive value or None otherwise.

This is guaranteed to return some slice if the value was produced by decoding in DER mode.

pub fn to_bytes(&self) -> Bytes

Produces a bytes value with the string’s content.

If the octet string was encoded as a single primitive value, the method will simply clone the content. Otherwise it will produce an entirely new bytes value from the concatenated content of all the primitive values.

pub fn len(&self) -> usize

Returns the length of the content.

This is not the length of the encoded value but of the actual octet string.

pub fn is_empty(&self) -> bool

Returns whether the content is empty.

pub fn encode_ref(&self) -> impl Values + '_

Returns a value encoder for the octet string using the natural tag.

pub fn encode_ref_as(&self, tag: Tag) -> impl Values + '_

Returns a value encoder for the octet string using the given tag.

Trait Implementations

impl<L: CharSet> AsRef<OctetString> for RestrictedString<L>

fn as_ref(&self) -> &OctetString

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

impl<L: Clone + CharSet> Clone for RestrictedString<L>

fn clone(&self) -> RestrictedString<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Debug + CharSet> Debug for RestrictedString<L>

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

Formats the value using the given formatter.

impl<L: CharSet> Deref for RestrictedString<L>

type Target = OctetString

The resulting type after dereferencing.

fn deref(&self) -> &OctetString

Dereferences the value.

impl<L: CharSet> Display for RestrictedString<L>

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

Formats the value using the given formatter.

impl<L: CharSet> FromStr for RestrictedString<L>

type Err = CharSetError

The associated error which can be returned from parsing.

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

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

impl<L: CharSet> Hash for RestrictedString<L>

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, 

Feeds a slice of this type into the given Hasher.

impl<'a, L: CharSet> IntoIterator for &'a RestrictedString<L>

type Item = &'a [u8]

The type of the elements being iterated over.

type IntoIter = OctetStringIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<L: CharSet> Ord for RestrictedString<L>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<L: CharSet> PartialEq<RestrictedString<L>> for RestrictedString<L>

fn eq(&self, other: &Self) -> 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 !=.

impl<L: CharSet> PartialOrd<RestrictedString<L>> for RestrictedString<L>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<L: CharSet> Eq for RestrictedString<L>