Struct rmpv::Utf8String
[−]
[src]
pub struct Utf8String { /* fields omitted */ }
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.
Methods
impl Utf8String
[src]
fn is_str(&self) -> bool
Returns true
if the string is valid UTF-8.
fn is_err(&self) -> bool
Returns true
if the string contains invalid UTF-8 sequence.
fn as_str(&self) -> Option<&str>
Returns the string reference if the string is valid UTF-8, or else None
.
fn as_err(&self) -> Option<&Utf8Error>
Returns the underlying Utf8Error
if the string contains invalud UTF-8 sequence, or
else None
.
fn as_bytes(&self) -> &[u8]
Returns a byte slice of this Utf8String
's contents.
fn into_str(self) -> Option<String>
Consumes this object, yielding the string if the string is valid UTF-8, or else None
.
fn into_bytes(self) -> Vec<u8>
Converts a Utf8String
into a byte vector.
Trait Implementations
impl Clone for Utf8String
[src]
fn clone(&self) -> Utf8String
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Debug for Utf8String
[src]
impl PartialEq for Utf8String
[src]
fn eq(&self, __arg_0: &Utf8String) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Utf8String) -> bool
This method tests for !=
.
impl Display for Utf8String
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more