Struct compact_str::CompactStr

pub struct CompactStr { /* fields omitted */ }

A CompactStr is a memory efficient immuatable string that can be used almost anywhere a String or &str can be used.

Using CompactStr

use compact_str::CompactStr;
use std::collections::HashMap;

// CompactStr auto derefs into a str so you can use all methods from `str` that take a `&self`
if CompactStr::new("hello world!").is_ascii() {
    println!("we're all ASCII")
}

// You can use a CompactStr in collections like you would a String or &str
let mut map: HashMap<CompactStr, CompactStr> = HashMap::new();

// directly construct a new `CompactStr`
map.insert(CompactStr::new("nyc"), CompactStr::new("empire state building"));
// create a `CompactStr` from a `&str`
map.insert("sf".into(), "transamerica pyramid".into());
// create a `CompactStr` from a `String`
map.insert(String::from("sea").into(), String::from("space needle").into());

fn wrapped_print<T: AsRef<str>>(text: T) {
    println!("{}", text.as_ref());
}

// CompactStr impls AsRef<str> and Borrow<str>, so it can be used anywhere that excepts a generic string
if let Some(building) = map.get("nyc") {
    wrapped_print(building);
}

// CompactStr can also be directly compared to a String or &str
assert_eq!(CompactStr::new("chicago"), "chicago");
assert_eq!(CompactStr::new("houston"), String::from("houston"));

Implementations

impl CompactStr

pub fn new<T: AsRef<str>>(text: T) -> Self

pub const fn new_inline(text: &str) -> Self

pub fn as_str(&self) -> &str

pub fn is_heap_allocated(&self) -> bool

Trait Implementations

impl AsRef<str> for CompactStr

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for CompactStr

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CompactStr

fn clone(&self) -> CompactStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompactStr

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

Formats the value using the given formatter.

impl Default for CompactStr

fn default() -> Self

Returns the “default value” for a type.

impl Deref for CompactStr

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Display for CompactStr

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

Formats the value using the given formatter.

impl<'a> From<&'a String> for CompactStr

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

Performs the conversion.

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

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

Performs the conversion.

impl From<String> for CompactStr

fn from(s: String) -> Self

Performs the conversion.

impl Hash for CompactStr

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 CompactStr

fn cmp(&self, other: &Self) -> 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

Restrict a value to a certain interval.

impl PartialEq<CompactStr> for String

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

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

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

This method tests for !=.

impl<T: AsRef<str>> PartialEq<T> for CompactStr

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

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

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

This method tests for !=.

impl PartialOrd<CompactStr> for CompactStr

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

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

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

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

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

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

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 Eq for CompactStr