Struct InternedStr

pub struct InternedStr<'a> { /* private fields */ }

An interned string.

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 arena = rsjsonnet_lang::arena::Arena::new();
let interner = rsjsonnet_lang::interner::StrInterner::new();

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

let a2 = interner.intern(&arena, "a");
let b2 = interner.intern(&arena, "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<'a> InternedStr<'a>

pub fn value(&self) -> &'a str

Returns the underlying string value.

Trait Implementations

impl<'a> Clone for InternedStr<'a>

fn clone(&self) -> InternedStr<'a>

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<'a> Hash for InternedStr<'a>

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<'a> Ord for InternedStr<'a>

fn cmp(&self, other: &InternedStr<'a>) -> 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<'a> PartialEq for InternedStr<'a>

fn eq(&self, other: &InternedStr<'a>) -> 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<'a> PartialOrd for InternedStr<'a>

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

impl<'a> Eq for InternedStr<'a>

impl<'a> StructuralPartialEq for InternedStr<'a>