Struct Text 

pub struct Text { /* private fields */ }

Text of a string or an atom.

The platform keeps text as UTF-16 code units and writes each surrogate of a quoted string as an escape "\xxxx, so a string may hold an unpaired surrogate. Text keeps such strings without losses; as_str gives None for them and to_string_lossy replaces unpaired surrogates with U+FFFD.

Stored as WTF-8: UTF-8 that also encodes unpaired surrogates. Text without them is plain UTF-8.

Implementations

impl Text

pub fn new() -> Self

pub fn from_utf16(units: &[u16]) -> Self

Text from UTF-16 code units; unpaired surrogates are kept.

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

The text, unless it holds an unpaired surrogate.

pub fn to_string_lossy(&self) -> Cow<'_, str>

The text with unpaired surrogates replaced by U+FFFD.

pub fn into_string(self) -> Result<String, Text>

The text as a String; Err gives it back if it holds an unpaired surrogate.

pub fn encode_utf16(&self) -> impl Iterator<Item = u16> + '_

UTF-16 code units, as the platform keeps the text.

pub fn code_points(&self) -> impl Iterator<Item = u32> + '_

Unicode code points; unpaired surrogates come as themselves (0xD800..=0xDFFF).

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

WTF-8 bytes: UTF-8 if the text has no unpaired surrogates.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Length in WTF-8 bytes.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Like str; unpaired surrogates are shown as \u{d800}.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Text

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Text

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

Unpaired surrogates are shown as U+FFFD.

impl Eq for Text

impl From<&String> for Text

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&Text> for Text

fn from(text: &Text) -> Self

Converts to this type from the input type.

impl From<&str> for Text

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for Text

fn from(s: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<char> for Text

fn from(c: char) -> Self

Converts to this type from the input type.

impl Hash for Text

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 Ord for Text

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Text

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Text

fn eq(&self, other: &&str) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for Text

fn eq(&self, other: &String) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Text

fn eq(&self, other: &str) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Text

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Text

Available on crate feature serde only.

Positions are not written: they belong to the parsed text. A string; text with an unpaired surrogate cannot be serialized.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Text