Enums

The enum keyword allows the creation of a type which has a few different variants:

  1. #[derive(Debug)]
  2. enum Direction {
  3.     Left,
  4.     Right,
  5. }
  7. #[derive(Debug)]
  8. enum PlayerMove {
  9.     Pass,                        // Simple variant
  10.     Run(Direction),              // Tuple variant
  11.     Teleport { x: u32, y: u32 }, // Struct variant
  12. }
  14. fn main() {
  15.     let player_move: PlayerMove = PlayerMove::Run(Direction::Left);
  16.     println!("On this turn: {player_move:?}");
  17. }

This slide should take about 5 minutes.

Key Points:

  • Enumerations allow you to collect a set of values under one type.
  • Direction is a type with variants. There are two values of Direction: Direction::Left and Direction::Right.
  • PlayerMove is a type with three variants. In addition to the payloads, Rust will store a discriminant so that it knows at runtime which variant is in a PlayerMove value.
  • This might be a good time to compare structs and enums:
    • In both, you can have a simple version without fields (unit struct) or one with different types of fields (variant payloads).
    • You could even implement the different variants of an enum with separate structs but then they wouldn’t be the same type as they would if they were all defined in an enum.

  • Rust uses minimal space to store the discriminant.

    • If necessary, it stores an integer of the smallest required size

    • If the allowed variant values do not cover all bit patterns, it will use invalid bit patterns to encode the discriminant (the “niche optimization”). For example, Option<&u8> stores either a pointer to an integer or NULL for the None variant.

    • You can control the discriminant if needed (e.g., for compatibility with C):

      1. #[repr(u32)]
      2. enum Bar {
      3.     A, // 0
      4.     B = 10000,
      5.     C, // 10001
      6. }
      8. fn main() {
      9.     println!("A: {}", Bar::A as u32);
      10.     println!("B: {}", Bar::B as u32);
      11.     println!("C: {}", Bar::C as u32);
      12. }

      Without repr, the discriminant type takes 2 bytes, because 10001 fits 2 bytes.

More to Explore

Rust has several optimizations it can employ to make enums take up less space.

  • Null pointer optimization: For some types, Rust guarantees that size_of::<T>() equals size_of::<Option<T>>().

    Example code if you want to show how the bitwise representation may look like in practice. It’s important to note that the compiler provides no guarantees regarding this representation, therefore this is totally unsafe.

    1. use std::mem::transmute;
    3. macro_rules! dbg_bits {
    4.     ($e:expr, $bit_type:ty) => {
    5.         println!("- {}: {:#x}", stringify!($e), transmute::<_, $bit_type>($e));
    6.     };
    7. }
    9. fn main() {
    10.     unsafe {
    11.         println!("bool:");
    12.         dbg_bits!(false, u8);
    13.         dbg_bits!(true, u8);
    15.         println!("Option<bool>:");
    16.         dbg_bits!(None::<bool>, u8);
    17.         dbg_bits!(Some(false), u8);
    18.         dbg_bits!(Some(true), u8);
    20.         println!("Option<Option<bool>>:");
    21.         dbg_bits!(Some(Some(false)), u8);
    22.         dbg_bits!(Some(Some(true)), u8);
    23.         dbg_bits!(Some(None::<bool>), u8);
    24.         dbg_bits!(None::<Option<bool>>, u8);
    26.         println!("Option<&i32>:");
    27.         dbg_bits!(None::<&i32>, usize);
    28.         dbg_bits!(Some(&0i32), usize);
    29.     }
    30. }