Struct ustr::Ustr

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

A handle representing a string in the global string cache.

To use, create one using Ustr::from or the ustr function. You can freely copy, destroy or send Ustrs to other threads: the underlying string is always valid in memory (and is never destroyed).

Methods

impl Ustr

pub fn from(string: &str) -> Ustr

Create a new Ustr from the given &str.

You can also use the ustr function

use ustr::{Ustr, ustr as u};

let u1 = Ustr::from("the quick brown fox");
let u2 = u("the quick brown fox");
assert_eq!(u1, u2);
assert_eq!(ustr::num_entries(), 1);

pub fn as_str(&self) -> &str

Get the cached string as a &str

use ustr::ustr as u;

let u_fox = u("the quick brown fox");
let words: Vec<&str> = u_fox.as_str().split_whitespace().collect();
assert_eq!(words, ["the", "quick", "brown", "fox"]);

pub unsafe fn as_char_ptr(&self) -> *const c_char

Get the cached string as a C char*.

This includes the null terminator so is safe to pass straight to FFI.

use ustr::ustr as u;

let u_fox = u("the quick brown fox");
let len = unsafe {
    libc::strlen(u_fox.as_char_ptr())
};
assert_eq!(len, 19);

Safety

This is just passing a raw byte array with a null terminator to C. If your source string contains non-ascii bytes then this will pass them straight along with no checking. The string is immutable. That means that if you modify it across the FFI boundary then all sorts of terrible things will happen.

pub fn len(&self) -> usize

Get the length (in bytes) of this string.

pub fn precomputed_hash(&self) -> u64

Get the precomputed hash for this string

pub fn to_owned(&self) -> String

Get an owned String copy of this string.

Trait Implementations

impl AsRef<str> for Ustr

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Ustr

fn clone(&self) -> Ustr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Ustr

impl Debug for Ustr

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

Formats the value using the given formatter.

impl Display for Ustr

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

Formats the value using the given formatter.

impl Eq for Ustr

impl<'_> From<&'_ str> for Ustr

fn from(s: &str) -> Ustr

Performs the conversion.

impl From<String> for Ustr

fn from(s: String) -> Ustr

Performs the conversion.

impl Hash for Ustr

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<'_> PartialEq<&'_ str> for Ustr

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 PartialEq<String> for Ustr

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 PartialEq<Ustr> for Ustr

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

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

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

This method tests for !=.

impl PartialOrd<Ustr> for Ustr

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

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

fn lt(&self, other: &Ustr) -> bool

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

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

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

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

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

fn ge(&self, other: &Ustr) -> bool

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

impl Send for Ustr

impl StructuralPartialEq for Ustr

impl Sync for Ustr