ordofp_core 0.1.0

//! Types used for indexing into `HLists` and Disiunctiones.
//!
//! ordofp frequently uses phantom index types as a technique to avoid
//! overlapping impls for some traits.
//!
//! Currently, `Index` type parameters in traits are not ever really intended
//! to be selected by the user, and are instead simply solved for by type
//! inference wherever the compiler can see that there is a unique solution.
//! Therefore, you don't really have much of a reason to use the things in this
//! module.
//!
//! **...yet.** `;)`

use core::marker::PhantomData;

// Largely lifted from https://github.com/Sgeo/hlist/blob/master/src/lib.rs#L30

/// Used as an index into an `HList`.
///
/// `Here` is 0, pointing to the head of the `HList`.
///
/// Users should normally allow type inference to create this type.
pub struct Here {
    _priv: (),
}

/// Used as an index into an `HList`.
///
/// `There<T>` is 1 + `T`.
///
/// Users should normally allow type inference to create this type.
pub struct There<T> {
    _marker: PhantomData<T>,
}

/// An index denoting that `Suffix` is just that.
pub struct Suffixed<Suffix> {
    _marker: PhantomData<Suffix>,
}

/// Index for the case where we don't need to do any transfiguring at all because the source
/// type is the same as the target type.
pub enum IdentityTransfig {}

/// Index for the case where we need to do work in order to transfigure one type into another.
pub struct DoTransfig<PluckByKeyIndex, TransfigIndex> {
    _marker1: PhantomData<PluckByKeyIndex>,
    _marker2: PhantomData<TransfigIndex>,
}

/// Index type wrapper for transfiguring a Universalis Source to a Universalis Target
pub struct NominataUniversalisTransfigIndicesWrapper<T>(PhantomData<T>);

/// Index type wrapper for transfiguring a Universalis plucked Source to a Universalis Target
pub struct PluckedNominataUniversalisIndicesWrapper<T>(T);

/// Index type wrapper for transfiguring through a (known) container (e.g. `Vec`).
pub struct MappingIndicesWrapper<T>(PhantomData<T>);