Struct Utf8String

pub struct Utf8String { /* private fields */ }

Represents an UTF-8 MessagePack string type.

According to the MessagePack spec, string objects may contain invalid byte sequence and the behavior of a deserializer depends on the actual implementation when it received invalid byte sequence. Deserializers should provide functionality to get the original byte array so that applications can decide how to handle the object.

Summarizing, it’s prohibited to instantiate a string type with invalid UTF-8 sequences, however it is possible to obtain an underlying bytes that were attempted to convert to a String. This may happen when trying to unpack strings that were decoded using older MessagePack spec with raw types instead of string/binary.

Implementations

impl Utf8String

pub fn is_str(&self) -> bool

Returns true if the string is valid UTF-8.

pub fn is_err(&self) -> bool

Returns true if the string contains invalid UTF-8 sequence.

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

Returns the string reference if the string is valid UTF-8, or else None.

pub fn as_err(&self) -> Option<&Utf8Error>

Returns the underlying Utf8Error if the string contains invalud UTF-8 sequence, or else None.

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice of this Utf8String’s contents.

pub fn into_str(self) -> Option<String>

Consumes this object, yielding the string if the string is valid UTF-8, or else None.

pub fn into_bytes(self) -> Vec<u8>

Converts a Utf8String into a byte vector.

pub fn as_ref(&self) -> Utf8StringRef<'_>

Trait Implementations

impl Clone for Utf8String

fn clone(&self) -> Utf8String

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Utf8String

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

Formats the value using the given formatter.

impl Display for Utf8String

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Utf8String

fn from(val: &str) -> Utf8String

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Utf8String

fn from(val: Cow<'a, str>) -> Utf8String

Converts to this type from the input type.

impl<'a> From<String> for Utf8String

fn from(val: String) -> Utf8String

Converts to this type from the input type.

impl PartialEq for Utf8String

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

type Error = Value

The type returned in the event of a conversion error.

fn try_from( val: Value, ) -> Result<Utf8String, <Utf8String as TryFrom<Value>>::Error>

Performs the conversion.

impl StructuralPartialEq for Utf8String