Struct Interned 

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

A statically interned value of type T.

An Interned<T> is a compact, copyable handle that deduplicates equal values and compares in O(1) using its index. It behaves like &'static T via Deref, and can be obtained with [InternExtTrait::intern] or Interned::intern.

Implementations

impl<T: Internable> Interned<T>

pub fn intern(value: &T) -> Self

Interns a value and returns its compact handle.

If an equal value has been interned before, this returns the existing handle; otherwise it inserts the value into the global table.

pub fn get(self) -> &'static T

Returns a &'static T for this handle.

Safety & Lifetimes

This method relies on the fact that the backing storage lives for the entire program (it is kept in a static global table). The 'static reference is sound as long as values are never removed from that table. This implementation uses transmute internally for that reason.

Trait Implementations

impl<T: Internable> AsRef<T> for Interned<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Interned<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Internable + Debug> Debug for Interned<T>

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

Formats the value using the given formatter.

impl<T: Internable> Deref for Interned<T>

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

Dereferences to the underlying value (&'static T).

Equivalent to calling Interned::get.

type Target = T

The resulting type after dereferencing.

impl<'a, T: Deserialize<'a> + Internable> Deserialize<'a> for Interned<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl<T: Hash> 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: JsonSchema> JsonSchema for Interned<T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl<T: Eq> Ord for Interned<T>

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 PartialEq<GlobalId> for Interned<DefIdInner>

fn eq(&self, other: &GlobalId) -> 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<Interned<DefIdInner>> for GlobalId

fn eq(&self, other: &Interned<DefIdInner>) -> 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: PartialEq> PartialEq for Interned<T>

fn eq(&self, other: &Interned<T>) -> 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: Eq> PartialOrd for Interned<T>

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: Serialize + Internable> Serialize for Interned<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for Interned<T>

impl<T: Eq> Eq for Interned<T>

impl<T> StructuralPartialEq for Interned<T>