Struct rsjsonnet_lang::interner::InternedStr

pub struct InternedStr { /* private fields */ }

A reference counted interned string.

Cloning will increase the reference count and is equivalent to calling StrInterner::intern with the same string value.

Also implements Eq, Ord and Hash. Note that comparison and hashing is done on the internal pointer value, not the actual string value. This means that:

• It does not make sense to compare InternedStr values from different StrInterner instances,
• Ord should not be relied to be deterministic.

let interner = rsjsonnet_lang::interner::StrInterner::new();

let a1 = interner.intern("a");
let b1 = interner.intern("b");

let a2 = interner.intern("a");
let b2 = interner.intern("b");

// Of course, they are equal.
assert_eq!(a1, a2);

// "a" and "b" are not equal, but there is no guarantee on the exact ordering.
let cmp1 = a1.cmp(&b1);
assert_ne!(cmp1, std::cmp::Ordering::Equal);

// But the ordering is consistent because they came from the same interner.
let cmp2 = a2.cmp(&b2);
assert_eq!(cmp1, cmp2);

Implementations

impl InternedStr

pub fn value(&self) -> &str

Returns the underlying string value.

Trait Implementations

impl Clone for InternedStr

fn clone(&self) -> InternedStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InternedStr

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

Formats the value using the given formatter.

impl Hash for InternedStr

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 InternedStr

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

Restrict a value to a certain interval.

impl PartialEq for InternedStr

fn eq(&self, other: &InternedStr) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for InternedStr

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

impl StructuralPartialEq for InternedStr