Phantom type parameters

A phantom type parameter is one that doesn’t show up at runtime,
but is checked statically (and only) at compile time.

Data types can use extra generic type parameters to act as markers
or to perform type checking at compile time. These extra parameters
hold no storage values, and have no runtime behavior.

In the following example, we combine std::marker::PhantomData
with the phantom type parameter concept to create tuples containing
different data types.

  1. use std::marker::PhantomData;
  3. // A phantom tuple struct which is generic over `A` with hidden parameter `B`.
  4. #[derive(PartialEq)] // Allow equality test for this type.
  5. struct PhantomTuple<A, B>(A,PhantomData<B>);
  7. // A phantom type struct which is generic over `A` with hidden parameter `B`.
  8. #[derive(PartialEq)] // Allow equality test for this type.
  9. struct PhantomStruct<A, B> { first: A, phantom: PhantomData<B> }
  11. // Note: Storage is allocated for generic type `A`, but not for `B`.
  12. //       Therefore, `B` cannot be used in computations.
  14. fn main() {
  15.     // Here, `f32` and `f64` are the hidden parameters.
  16.     // PhantomTuple type specified as `<char, f32>`.
  17.     let _tuple1: PhantomTuple<char, f32> = PhantomTuple('Q', PhantomData);
  18.     // PhantomTuple type specified as `<char, f64>`.
  19.     let _tuple2: PhantomTuple<char, f64> = PhantomTuple('Q', PhantomData);
  21.     // Type specified as `<char, f32>`.
  22.     let _struct1: PhantomStruct<char, f32> = PhantomStruct {
  23.         first: 'Q',
  24.         phantom: PhantomData,
  25.     };
  26.     // Type specified as `<char, f64>`.
  27.     let _struct2: PhantomStruct<char, f64> = PhantomStruct {
  28.         first: 'Q',
  29.         phantom: PhantomData,
  30.     };
  32.     // Compile-time Error! Type mismatch so these cannot be compared:
  33.     //println!("_tuple1 == _tuple2 yields: {}",
  34.     //          _tuple1 == _tuple2);
  36.     // Compile-time Error! Type mismatch so these cannot be compared:
  37.     //println!("_struct1 == _struct2 yields: {}",
  38.     //          _struct1 == _struct2);
  39. }

See also:

Derive, struct, and TupleStructs