Struct kstring::KString

#[repr(transparent)]pub struct KString { /* fields omitted */ }

A UTF-8 encoded, immutable string.

Implementations

impl KString

pub fn new() -> Self

Create a new empty KString.

pub fn from_boxed(other: Box<str>) -> Self

Create an owned KString.

pub fn from_string(other: String) -> Self

Create an owned KString.

pub fn from_ref(other: &str) -> Self

Create an owned KString optimally from a reference.

pub fn from_static(other: &'static str) -> Self

Create a reference to a 'static data.

pub fn as_ref(&self) -> KStringRef

Get a reference to the KString.

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire KString.

pub fn into_string(self) -> String

Convert to a mutable string type, cloning the data if necessary.

pub fn into_boxed_str(self) -> Box<str>

Convert to a mutable string type, cloning the data if necessary.

pub fn into_cow_str(self) -> Cow<'static, str>

Convert to a Cow str

Trait Implementations

impl AsRef<[u8]> for KString

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<OsStr> for KString

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for KString

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<str> for KString

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for KString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for KString

fn clone(&self) -> KString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KString

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

Formats the value using the given formatter.

impl Default for KString

fn default() -> Self

Returns the "default value" for a type.

impl Deref for KString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'de> Deserialize<'de> for KString

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

Deserialize this value from the given Serde deserializer.

impl Display for KString

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

Formats the value using the given formatter.

impl Eq for KString

impl<'s> From<&'s Box<str>> for KString

fn from(other: &'s Box<str>) -> Self

Performs the conversion.

impl<'s> From<&'s KString> for KStringCow<'s>

fn from(other: &'s KString) -> Self

Performs the conversion.

impl<'s> From<&'s KString> for KStringRef<'s>

fn from(other: &'s KString) -> Self

Performs the conversion.

impl<'s> From<&'s KStringCow<'s>> for KString

fn from(other: &'s KStringCow<'s>) -> Self

Performs the conversion.

impl<'s> From<&'s KStringRef<'s>> for KString

fn from(other: &'s KStringRef<'s>) -> Self

Performs the conversion.

impl From<&'static str> for KString

fn from(other: &'static str) -> Self

Performs the conversion.

impl From<Box<str>> for KString

fn from(other: Box<str>) -> Self

Performs the conversion.

impl From<KString> for KStringCow<'static>

fn from(other: KString) -> Self

Performs the conversion.

impl<'s> From<KStringCow<'s>> for KString

fn from(other: KStringCow<'s>) -> Self

Performs the conversion.

impl<'s> From<KStringRef<'s>> for KString

fn from(other: KStringRef<'s>) -> Self

Performs the conversion.

impl From<String> for KString

fn from(other: String) -> Self

Performs the conversion.

impl Hash for KString

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'s> PartialEq<&'s str> for KString

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<'s> PartialEq<KString> for KString

fn eq(&self, other: &KString) -> 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<'s> PartialEq<String> for KString

fn eq(&self, other: &String) -> 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<'s> PartialEq<str> for KString

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 PartialOrd<KString> for KString

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl Serialize for KString

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

Serialize this value into the given Serde serializer.