Struct RefString 

pub struct RefString(/* private fields */);

A weak reference to a garbage collected, interned string.

Implementations

impl RefString

pub fn new<'a>(s: impl Into<Cow<'a, str>>) -> Self

Returns a reference to a garbage collected string that contains s.

If another RootString or RefString exists already with the same contents as s, it will be returned and s will be dropped.

pub fn from_any(any: AnyRef) -> Option<Self>

Upgrades a typeless reference to a pooled string reference.

Returns None if any is not a pooled string.

pub fn load<'guard>( &self, guard: &'guard CollectionGuard<'_>, ) -> Option<&'guard str>

Loads a reference to the underlying string, if the string hasn’t been freed.

pub fn as_root(&self, guard: &CollectionGuard<'_>) -> Option<RootString>

Loads this string as a root, if the string hasn’t been freed.

pub fn as_any(&self) -> AnyRef

Returns a typeless reference to this string.

Trait Implementations

impl Clone for RefString

fn clone(&self) -> RefString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RefString

impl Debug for RefString

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

Formats the value using the given formatter.

impl Eq for RefString

impl From<&String> for RefString

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for RefString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for RefString

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for RefString

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

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RefString

fn eq(&self, other: &RefString) -> 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 PartialEq<RefString> for RootString

fn eq(&self, other: &RefString) -> 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 PartialEq<RootString> for RefString

fn eq(&self, other: &RootString) -> 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 PartialOrd for RefString

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for RefString

impl Trace for RefString

const MAY_CONTAIN_REFERENCES: bool

If true, this type may contain references and should have its trace() function invoked during the collector’s “mark” phase.

fn trace(&self, tracer: &mut Tracer<'_>)

Traces all refrences that this value references.