Compile-time classification of types according to the Rust specification.
RustSpec describes a type across the following axes:
Layout: representation stability.Size: statically sized, metadata-sized, or extern-type-like shape.Trap: whether the value representation has trap values.Niche: whether a type has a stable, unstable, or no niche value.Drop: whether droping runs custom or compiler-generated code.Mutability: whether type can be mutated through shared access.Opacity: whether the value representation may be inspected.
Describes total reachable (through pointer indirection) representation stability:
Stable: compiler-guaranteed representation.Unstable: representation is not guaranteed.
Describes compile-time size and pointer metadata shape:
Sized<Zero>: compile-time known zero-sized type.Sized<Gt<Zero>>: compile-time known non-zero-sized type.MetaSized<SliceLike>: dynamically sized slice-like type.MetaSized<DynTraitLike>: dynamically sized trait-object-like type.ExternTypeLike: dynamically sized extern-type-like type.NulTerminated: unsized data whose length is found from a nul terminator.
Describes total reachable (through pointer indirection) value-representation validity:
Robust: every bit pattern (through indirection) is valid.NonRobust: some bit patterns are trap/invalid values.
This classification does not establish provenance, alignment, lifetimes, or aliasing
requirements for pointers and references. For example, Option<&u8> is Robust, but
a non-null representation must still be a valid reference before constructing the value.
Describes whether and what kind of niche is available for the type:
WithoutNiche: no niche is available.WithNiche<Stable>: compiler-guaranteed niche.WithNiche<Unstable>: niche exists but is not guaranteed.
Use #[rust_spec(custom_niche)] when deriving RustSpec to select WithNiche<Unstable>.
Describes the type's behavior when dropped:
NoDrop: dropping the type runs no drop glue.AutoDrop: a field or other owned content has drop behavior.CustomDrop<NoDrop>: the type implementsDropwithout any compiler-generated "drop glue".CustomDrop<AutoDrop>: the type implementsDropand owns content that needs drop glue.
Use #[rust_spec(custom_drop)] when deriving RustSpec for a type that implements Drop.
RustSpec::Mutability classifies shared-access mutability:
mutability::Exclusive<WithoutInterior>: mutation requires exclusive access.mutability::WithInterior<Robust>: only robust parts can be mutated through shared access.mutability::WithInterior<NonRobust>: non-robust parts can be mutated through shared access.
NonOpaque: the value representation is not opaque.Opaque: the value must appear only behind an indirection.
Use #[rust_spec(opaque)] when deriving [RustSpec] to classify type as Opaque.
Derive RustSpec for your types, then use its associated marker families as bounds when implementing other traits:
use disjoint_impls::disjoint_impls;
use rust_spec::{RustSpec, Stable, Unstable, niche::{WithNiche, WithoutNiche}};
#[derive(RustSpec)]
struct Header {
id: u32,
flags: u16,
}
disjoint_impls! {
trait NullableEncoding {
const NEEDS_TAG: bool;
}
impl<T: RustSpec<Niche = WithoutNiche>> NullableEncoding for T {
const NEEDS_TAG: bool = true;
}
impl<T: RustSpec<Niche = WithNiche<Stable>>> NullableEncoding for T {
const NEEDS_TAG: bool = false;
}
impl<T: RustSpec<Niche = WithNiche<Unstable>>> NullableEncoding for T {
const NEEDS_TAG: bool = false;
}
}
const HEADER_OPTION_NEEDS_TAG: bool = Header::NEEDS_TAG;Check out CO3 to see how this crate allows for building higher zero-cost abstractions.