Struct KdlString 

pub struct KdlString<'a> { /* private fields */ }

A KDL string, parsed from an identifier, escaped string, or raw string. Exists in either Owned or Borrowed form, depending on whether there were escapes in the string. Doesn’t track the origin of the string (identifier, escaped, or raw), because KDL semantics treat them all identically.

Implementations

impl<'a> KdlString<'a>

pub fn new() -> Self

Create a new, empty KDL String

pub fn from_cow(cow: Cow<'a, str>) -> Self

Create a KDL string from a Cow<str>.

pub fn from_borrowed(s: &'a str) -> Self

Create a borrowed KDL string

pub fn from_string(s: String) -> Self

Create an owned KDL string

pub fn into_string(self) -> String

Convert this unconditionally into an owned string.

pub fn as_str(&self) -> &str

Get the &str contained in this string.

pub fn visit_to<V, E>(self, visitor: V) -> Result<V::Value, E>

where V: Visitor<'a>, E: Error,

Apply a KDL string to a visitor

Methods from Deref<Target = Cow<'a, str>>

pub fn to_mut(&mut self) -> &mut <B as ToOwned>::Owned

Acquires a mutable reference to the owned form of the data.

Clones the data if it is not already owned.

Examples

use std::borrow::Cow;

let mut cow = Cow::Borrowed("foo");
cow.to_mut().make_ascii_uppercase();

assert_eq!(
  cow,
  Cow::Owned(String::from("FOO")) as Cow<'_, str>
);

Trait Implementations

impl AsRef<str> for KdlString<'_>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for KdlString<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for KdlString<'a>

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

Formats the value using the given formatter.

impl Default for KdlString<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Deref for KdlString<'a>

type Target = Cow<'a, str>

The resulting type after dereferencing.

fn deref(&self) -> &Cow<'a, str>

Dereferences the value.

impl DerefMut for KdlString<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for KdlString<'de>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'b> Extend<&'b char> for KdlString<'a>

fn extend<T: IntoIterator<Item = &'b char>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<&'a str> for KdlString<'a>

fn extend<T: IntoIterator<Item = &'a str>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<char> for KdlString<'_>

fn extend<T: IntoIterator<Item = char>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<T> FromIterator<T> for KdlString<'_>

where Self: Extend<T>,

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for KdlString<'_>

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<T: AsRef<str>> PartialEq<T> for KdlString<'_>

fn eq(&self, other: &T) -> 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 Serialize for KdlString<'_>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StringBuilder<'a> for KdlString<'a>

fn push_str(&mut self, s: &'a str)

Add a borrowed string to the back of this string

fn push_char(&mut self, c: char)

Add a char to the back of this string

fn from_str(s: &'a str) -> Self

Create a new instance from a borrowed string

fn empty() -> Self

Create a new empty instance

impl<'a> Eq for KdlString<'a>