#variance #marker #subtype

no-std type-variance

Marker traits for subtype variance

4 releases

0.1.0 Sep 1, 2020
0.0.3 Aug 14, 2020
0.0.2 Jul 19, 2020
0.0.1 Jul 19, 2020

#1290 in Rust patterns

MIT license

12KB
75 lines

Variance

Variance is a set of PhantomData-like marker types that make it easier to specify the variance of your generic types with respect to their parameters.

Latest version Documentation License

Getting Started

The Variance crate is available on crates.io. Add the following dependency to your Cargo manifest:

[dependencies]
type-variance = "0.1.0"

See the docs for detailed usage information.

Example

The crate provides three zero-sized marker types: Covariant<T>, Contravariant<T>, and Invariant<T>, each marking the given type parameter as having the respective variance.

For example:

use type_variance::{Covariant, Contravariant};

// UnaryFunction is a zero-sized type that is covariant to `Arg` and
// contravariant to `Ret`.
struct UnaryFunction<Arg, Ret> {
    arg: Covariant<Arg>,
    ret: Contravariant<Ret>,
}

fn foo<'sup>() {
    // Here, the type &'static() is a subtype of &'sup().
    // Therefore, `Arg` may be replaced with a subtype and `Ret` may be
    // replaced with a supertype.
    let _func: UnaryFunction<&'sup(), &'static()> = UnaryFunction {
        arg: Covariant::<&'static()>::default(),
        ret: Contravariant::<&'sup()>::default(),
    };
}

License

This crate is MIT licensed.

No runtime deps