Struct Interned 

pub struct Interned<T: Hash> { /* private fields */ }

The main type of this crate. Represents a unique, heap-allocated, statically interned value that will exist for the life of the program.

Two instances of Interned for the same value T will always have the same heap memory address. Additionally, Interned values can be copied freely, since they are merely heap pointers.

Implementations

impl<T: Hash> Interned<T>

pub fn as_ptr(&self) -> *const ()

Provides raw access to the raw heap pointer for this Interned value. Doing something substantive with this value is unsafe. Useful for testing.

impl<T: Hash + Staticize + DataType<Type = Slice>> Interned<T>

pub fn interned_slice<'a>(&self) -> &'a [T::SliceValueType]

Returns a the underlying slice interned in this Interned. Calling this method on a non-slice will panic.

impl Interned<&str>

pub fn interned_str<'a>(&self) -> &'a str

Returns a reference to the underlying &str interned in this Interned. Calling this method on a non-string will panic.

impl Interned<&OsStr>

pub fn interned_os_str<'a>(&self) -> &'a OsStr

Returns a reference to the underlying &OsStr interned in this Interned. Calling this method on a non-OsStr will panic.

impl Interned<&Path>

pub fn interned_path<'a>(&self) -> &'a Path

Returns a reference to the underlying &Path interned in this Interned. Calling this method on a non-Path will panic.

impl<T: Hash + Staticize + DataType<Type = Value>> Interned<T>

pub fn interned_value<'a>(&self) -> &'a T

Returns a reference to the underlying T interned in this Interned. Calling this method on a non-value will panic.

Trait Implementations

impl<T: Clone + Hash> Clone for Interned<T>

fn clone(&self) -> Interned<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Hash + Staticize + DataType + Debug> Debug for Interned<T>

where <T as DataType>::SliceValueType: Debug,

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

Formats the value using the given formatter.

impl<T: Hash + Staticize + DataType> Deref for Interned<T>

type Target = <T as DataType>::DerefTargetType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Hash + Display> Display for Interned<T>

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

Formats the value using the given formatter.

impl From<Interned<&[bool]>> for &[bool]

fn from(value: Interned<&[bool]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[i128]>> for &[i128]

fn from(value: Interned<&[i128]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[i16]>> for &[i16]

fn from(value: Interned<&[i16]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[i32]>> for &[i32]

fn from(value: Interned<&[i32]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[i64]>> for &[i64]

fn from(value: Interned<&[i64]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[i8]>> for &[i8]

fn from(value: Interned<&[i8]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[u128]>> for &[u128]

fn from(value: Interned<&[u128]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[u16]>> for &[u16]

fn from(value: Interned<&[u16]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[u32]>> for &[u32]

fn from(value: Interned<&[u32]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[u64]>> for &[u64]

fn from(value: Interned<&[u64]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[u8]>> for &[u8]

fn from(value: Interned<&[u8]>) -> Self

Converts to this type from the input type.

impl From<Interned<&[usize]>> for &[usize]

fn from(value: Interned<&[usize]>) -> Self

Converts to this type from the input type.

impl From<Interned<&OsStr>> for &OsStr

fn from(value: Interned<&OsStr>) -> Self

Converts to this type from the input type.

impl From<Interned<&'static OsStr>> for InOsStr

fn from(value: Interned<&'static OsStr>) -> Self

Converts to this type from the input type.

impl From<Interned<&Path>> for &Path

fn from(value: Interned<&Path>) -> Self

Converts to this type from the input type.

impl From<Interned<&'static Path>> for InPath

fn from(value: Interned<&'static Path>) -> Self

Converts to this type from the input type.

impl From<Interned<&str>> for &str

fn from(value: Interned<&str>) -> Self

Converts to this type from the input type.

impl From<Interned<&'static str>> for InStr

fn from(value: Interned<&'static str>) -> Self

Converts to this type from the input type.

impl From<Interned<bool>> for bool

fn from(value: Interned<bool>) -> Self

Converts to this type from the input type.

impl From<Interned<char>> for char

fn from(value: Interned<char>) -> Self

Converts to this type from the input type.

impl From<Interned<i128>> for i128

fn from(value: Interned<i128>) -> Self

Converts to this type from the input type.

impl From<Interned<i16>> for i16

fn from(value: Interned<i16>) -> Self

Converts to this type from the input type.

impl From<Interned<i32>> for i32

fn from(value: Interned<i32>) -> Self

Converts to this type from the input type.

impl From<Interned<i64>> for i64

fn from(value: Interned<i64>) -> Self

Converts to this type from the input type.

impl From<Interned<i8>> for i8

fn from(value: Interned<i8>) -> Self

Converts to this type from the input type.

impl From<Interned<u128>> for u128

fn from(value: Interned<u128>) -> Self

Converts to this type from the input type.

impl From<Interned<u16>> for u16

fn from(value: Interned<u16>) -> Self

Converts to this type from the input type.

impl From<Interned<u32>> for u32

fn from(value: Interned<u32>) -> Self

Converts to this type from the input type.

impl From<Interned<u64>> for u64

fn from(value: Interned<u64>) -> Self

Converts to this type from the input type.

impl From<Interned<u8>> for u8

fn from(value: Interned<u8>) -> Self

Converts to this type from the input type.

impl From<Interned<usize>> for usize

fn from(value: Interned<usize>) -> Self

Converts to this type from the input type.

impl<T: Hash + Copy + Staticize + DataType> From<Static> for Interned<T>

fn from(value: Static) -> Self

Converts to this type from the input type.

impl<T: Hash + Copy + Staticize + DataType + From<Interned<T>>> From<T> for Interned<T::Static>

where <T as Staticize>::Static: Hash + Sized,

fn from(value: T) -> Interned<T::Static>

Converts to this type from the input type.

impl<T: Hash + Staticize> Hash for Interned<T>

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<T: Hash + Staticize + Ord + DataType> Ord for Interned<T>

where <T as DataType>::SliceValueType: PartialEq,

fn cmp(&self, other: &Self) -> 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<T: Hash + PartialEq + Staticize + DataType> PartialEq for Interned<T>

where <T as DataType>::SliceValueType: PartialEq,

fn eq(&self, other: &Self) -> 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<T: Hash + Staticize + PartialOrd + DataType> PartialOrd for Interned<T>

where <T as DataType>::SliceValueType: PartialEq,

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

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<T: Copy + Hash> Copy for Interned<T>

impl<T> Eq for Interned<T>

where T: PartialEq + Hash + Staticize + Eq + DataType, <T as DataType>::SliceValueType: PartialEq,