Struct kserd::Kstr

pub struct Kstr<'a> {
    pub inner: Cow<'a, str>,
}

An owned or borrowed string.

Kstr provides a thin wrapper around Cow<str>. The smart pointer allows the string to be borrowed up until the point of mutation, at which point a clonse is made.

Fields

inner: Cow<'a, str>

Inner access to the underlying clone-on-write smart pointer.

Methods

impl<'a> Kstr<'a>

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

A new borrowed string. Kstr has the same lifetime as the borrowed string.

pub const fn owned(s: String) -> Kstr<'static>

A new owned string. Takes ownership of the string and has a 'static lifetime.

pub fn as_str(&self) -> &str

Represent the string as a string slice.

Example

let kstr = Kstr::owned(String::from("Hello, world!"));
assert_eq!(kstr.as_str(), "Hello, world!");

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

Acquires a mutable reference to the owned string.

Clones the string if it not already owned.

Example

let mut kstr = Kstr::brwed("foo");
kstr.to_mut().make_ascii_uppercase();
assert_eq!(kstr, Kstr::brwed("FOO"));

pub fn into_owned(self) -> Kstr<'static>

Makes the underlying string owned.

Clones the string if it is not already owned. This upgrades the lifetime to 'static.

Example

let kstr = Kstr::brwed("Hello, world!");
assert_eq!(kstr.to_owned(), Kstr::owned(String::from("Hello, world!")));

Trait Implementations

impl<'a> AsRef<str> for Kstr<'a>

fn as_ref(&self) -> &str

Performs the conversion.

impl<'a> Clone for Kstr<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Kstr<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Kstr<'a>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'a> Display for Kstr<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Kstr<'a>

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

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

Performs the conversion.

impl From<String> for Kstr<'static>

fn from(s: String) -> Self

Performs the conversion.

impl<'a> Hash for Kstr<'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, 

Feeds a slice of this type into the given [Hasher].

impl<'a> Ord for Kstr<'a>

fn cmp(&self, other: &Kstr<'a>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<'a> PartialEq<Kstr<'a>> for Kstr<'a>

fn eq(&self, other: &Kstr<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Kstr<'a>) -> bool

This method tests for !=.

impl<'a> PartialEq<str> for Kstr<'a>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialOrd<Kstr<'a>> for Kstr<'a>

fn partial_cmp(&self, other: &Kstr<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Kstr<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Kstr<'a>) -> bool

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

fn gt(&self, other: &Kstr<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Kstr<'a>) -> bool

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

impl<'a> StructuralEq for Kstr<'a>

impl<'a> StructuralPartialEq for Kstr<'a>