Struct TextString 

pub struct TextString<'a>(/* private fields */);

Conversion helper for Value::text_string.

Wraps a Cow<'a, str> so that Value::text_string can accept owned and borrowed string inputs through a single impl Into<TextString> bound. This mirrors how Array and Map abstract their input shapes.

Supported source types:

• &'a str (and any &'a T with T: AsRef<str>) borrows zero-copy.
• Owned String is moved without copying.
• Cow<'a, str> is preserved as-is.
• char allocates a one-character String.

// Borrows from the literal:
let v = Value::text_string("hello");
assert_eq!(v.as_str().unwrap(), "hello");

// Owns its storage:
let v = Value::text_string(String::from("hello"));
assert_eq!(v.as_str().unwrap(), "hello");

Implementations

impl<'a> TextString<'a>

pub const fn new() -> Self

Create an empty text string.

The result is Cow::Borrowed("") and lives for any lifetime.

pub fn as_str(&self) -> &str

Borrow the contents as a &str.

pub fn as_string_mut(&mut self) -> &mut String

Borrow the contents as a mutable String, cloning if the inner Cow is currently borrowed.

pub fn into_owned<'b>(self) -> TextString<'b>

Detach from any borrow, returning a TextString with an independent lifetime.

A borrowed TextString<'a> is copied into an owned String; an already-owned one is returned unchanged. The result can be assigned to any lifetime, in particular TextString<'static>.

Trait Implementations

impl<'a> Clone for TextString<'a>

fn clone(&self) -> TextString<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TextString<'a>

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

Formats the value using the given formatter.

impl<'a> Default for TextString<'a>

fn default() -> TextString<'a>

Returns the “default value” for a type.

impl<'a, T> From<&'a T> for TextString<'a>

where T: AsRef<str> + ?Sized,

fn from(value: &'a T) -> Self

Converts to this type from the input type.

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

fn from(value: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<'a> From<String> for TextString<'a>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<'a> From<TextString<'a>> for Value<'a>

fn from(value: TextString<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<char> for TextString<'a>

fn from(value: char) -> Self

Converts to this type from the input type.

impl<'a> Hash for TextString<'a>

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<'a> Ord for TextString<'a>

fn cmp(&self, other: &TextString<'a>) -> 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.

impl<'a> PartialEq for TextString<'a>

fn eq(&self, other: &TextString<'a>) -> 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<'a> PartialOrd for TextString<'a>

fn partial_cmp(&self, other: &TextString<'a>) -> 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<'a> Eq for TextString<'a>

impl<'a> StructuralPartialEq for TextString<'a>