Struct refl::Id

pub struct Id<S: ?Sized, T: ?Sized>(_);

A proof term that S and T are the same type (type identity). This type is only ever inhabited when S is nominally equivalent to T.

A note on variance and safety

S and T are invariant here. This means that for two, possibly disjoint, lifetimes 'a, 'b we cannot construct an Id<&'a T, &'b T>. If we could, which we would if we had covariance, we could define the following unsound function in safe Rust:

fn transmute_lifetime<'a, 'b, T: 'a + 'b>(r: &'a T) -> &'b T {
    refl().cast(r)
}

See

• https://doc.rust-lang.org/nightly/nomicon/phantom-data.html
• https://doc.rust-lang.org/beta/nomicon/subtyping.html

for more information on variance.

Methods

impl<T: ?Sized> Id<T, T>

pub const REFL: Self

A proof witness of the fact that a type is equivalent to itself.

This is equivalent to refl().

impl<S: ?Sized, T: ?Sized> Id<S, T>

pub fn cast(self, value: S) -> T where
    S: Sized,
    T: Sized, 

Casts a value of type S to T.

This is safe because the Id type is always guaranteed to only be inhabited by Id<T, T> types by construction.

pub fn sym(self) -> Id<T, S>

Converts Id<S, T> into Id<T, S> since type equality is symmetric.

pub fn trans<U: ?Sized>(self, _: Id<T, U>) -> Id<S, U>

If you have proofs Id<S, T> and Id<T, U> you can conclude Id<S, U> since type equality is transitive.

pub fn cast_ref<'a>(self, value: &'a S) -> &'a T

Casts a value of type &S to &T where S == T.

use refl::*;

fn main() {
    let x: Box<u8> = Box::new(1);
    let refl: Id<Box<u8>, Box<u8>> = refl();
    assert_eq!(&x, refl.cast_ref(&x));
}

pub fn cast_ref_mut<'a>(self, value: &'a mut S) -> &'a mut T

Casts a value of type &S to &T where S == T.

use refl::*;

fn main() {
    let mut x: Box<u8> = Box::new(1);
    let refl: Id<Box<u8>, Box<u8>> = refl();
    **refl.cast_ref_mut(&mut x) += 1;
    assert_eq!(*x, 2);
}

Trait Implementations

impl<S: ?Sized, T: ?Sized> Clone for Id<S, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: ?Sized, T: ?Sized> Copy for Id<S, T>

impl<S: ?Sized, T: ?Sized> Debug for Id<S, T>

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

Formats the value using the given formatter.

impl<X: ?Sized> Default for Id<X, X>

fn default() -> Self

Returns the "default value" for a type.

impl<S: ?Sized, T: ?Sized> Eq for Id<S, T>

impl<S: ?Sized, T: ?Sized> Hash for Id<S, T>

fn hash<H: Hasher>(&self, _: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<S: ?Sized, T: ?Sized> Ord for Id<S, T>

fn cmp(&self, _other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<S: ?Sized, T: ?Sized> PartialEq<Id<S, T>> for Id<S, T>

fn eq(&self, _: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, _: &Self) -> bool

This method tests for !=.

impl<S: ?Sized, T: ?Sized> PartialOrd<Id<S, T>> for Id<S, T>

fn partial_cmp(&self, _: &Self) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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