Struct MysteryString 

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

A string whose encoding is defined by the IO system, but probably treated as Latin-1.

Strings of this type can be serialized into a story file (via the Item::MysteryString) constructor formatted compatibly with the streamstr instruction. Constructors ensure that it will not contain any embedded nulls. Internally it’s a Bytes, so cloning it is cheap.

This corresponds to a Glulx E0 string, of which the spec says “the encoding scheme is the business of the I/O system; in Glk, it will be the Latin-1 character set”. It is in any case required to be a single-byte encoding which uses a zero byte as a terminator.

When building a MysteryString from a char iterator or using its Display impl, Latin1 is assumed. However, you can also build it from a u8 iterator in which case no assumption is made about the encoding.

Implementations

impl MysteryString

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

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

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

If the string contains embedded nulls or any character which cannot be represented in Latin-1, an error is returned, but a lossy version can be extracted from the error struct. The lossy string replaces nulls and unrepresentable characters with b'?'.

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

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

Constructs a MysteryString from an iterator over u8s (or over any type that lets you borrow a u8).

If the string contains embedded nulls, an error is returned, but a lossy version can be extracted from the error struct. The lossy string is truncated at the first occurence of a null. (Unlike from_chars, this constructor doesn’t that the string is Latin-1 or even any ASCII superset, so therefore it can’t know what would be a reasonable replacement character to substitute.)

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 from_bytes_lossy<I, C>(chars: I) -> Self

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

Like from_bytes, 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 len(&self) -> usize

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

pub fn len_with_prefix_and_nul(&self) -> usize

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

pub fn to_bytes(&self) -> Bytes

Returns a clone of the string’s underlying Bytes.

pub fn into_bytes(self) -> Bytes

Unwraps the string into its underlying Bytes.

Trait Implementations

impl Clone for MysteryString

fn clone(&self) -> MysteryString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MysteryString

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

Formats the value using the given formatter.

impl Default for MysteryString

fn default() -> MysteryString

Returns the “default value” for a type.

impl Display for MysteryString

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

Formats the value using the given formatter.

impl Hash for MysteryString

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 MysteryString

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

type Error = StringConversionError<MysteryString>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&String> for MysteryString

type Error = StringConversionError<MysteryString>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Vec<u8>> for MysteryString

type Error = StringConversionError<MysteryString>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for MysteryString

type Error = StringConversionError<MysteryString>

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 MysteryString

type Error = StringConversionError<MysteryString>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for MysteryString

type Error = StringConversionError<MysteryString>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for MysteryString

impl StructuralPartialEq for MysteryString