Struct Utf32String

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

A string encoded as UTF-32.

Strings of this type can be serialized into a story file (via the Item::Utf32String constructor) formatted compatibly with the streamstr instruction. Constructors ensure that the string is valid Unicode with no embedded nulls. Internally it’s a Bytes, so cloning it is cheap.

This is not at all a full-featured alternative to std::String. Utf32Strings are immutable once constructed and not intended for anything other than being serialized into a story file.

Implementations

impl Utf32String

pub fn from_chars<I, C>(chars: I) -> Result<Self, StringConversionError<Self>>

where I: IntoIterator<Item = C>, C: Borrow<char>,

Construct a Utf32String from an iterator over chars (or over any type that lets you borrow a char).

If the string contains embedded nulls, an error is returned, but a lossy version can be extracted from the error struct. The lossy string replaces nulls with U+2400 SYMBOL FOR NULL (␀), which belongs to the Control Pictures block, which is a really neat block that I bet you didn’t know existed.

pub fn from_chars_lossy<I, C>(chars: I) -> Self

where I: IntoIterator<Item = C>, C: Borrow<char>,

Like from_chars, but in case of error will silently unwrap the error and return the lossy version.

pub fn is_empty(&self) -> bool

Returns true if the string is empty.

pub fn char_len(&self) -> usize

Returns the length of the string in characters.

pub fn byte_len(&self) -> usize

Returns the length of the string in bytes, excluding prefix and null terminator.

pub fn byte_len_with_prefix_and_nul(&self) -> usize

Returns the length of the string in bytes, including prefix and null terminator.

pub fn to_bytes(&self) -> Bytes

Returns a clone of the underlying Bytes.

pub fn into_bytes(self) -> Bytes

Unwraps the string into its underlying Bytes.

Trait Implementations

impl Clone for Utf32String

fn clone(&self) -> Utf32String

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utf32String

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

Formats the value using the given formatter.

impl Default for Utf32String

fn default() -> Utf32String

Returns the “default value” for a type.

impl Display for Utf32String

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

Formats the value using the given formatter.

impl Hash for Utf32String

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 PartialEq for Utf32String

fn eq(&self, other: &Utf32String) -> 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 TryFrom<&[char]> for Utf32String

type Error = StringConversionError<Utf32String>

The type returned in the event of a conversion error.

fn try_from(value: &[char]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&String> for Utf32String

type Error = StringConversionError<Utf32String>

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Utf32String

type Error = StringConversionError<Utf32String>

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Utf32String

type Error = StringConversionError<Utf32String>

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Utf32String

impl StructuralPartialEq for Utf32String