枚举

^语法

枚举 :

   enum 标识符 泛型参数^? Where 子句^? { 枚举项^? }

枚举项 :

   枚举项 ( , 枚举项 )^* ,^?

枚举项 :

   外部属性^* 可见性^?

   标识符 ( 枚举项元组 | 枚举项结构体 )^? 枚举项判别式^?

枚举项元组 :

   ( 元组字段^? )

枚举项结构体 :

   { 结构体字段^? }

枚举项判别式 :

   = 表达式

枚举，也称为 enum，是名义枚举类型以及一组构造函数的同步定义，可用于创建或模式匹配相应枚举类型的值。

枚举使用关键字 enum 声明。

enum 项及其用法的示例

#![allow(unused)]
fn main() {
enum Animal {
    Dog,
    Cat,
}

let mut a: Animal = Animal::Dog;
a = Animal::Cat;
}

枚举构造函数可以具有命名或未命名字段

#![allow(unused)]
fn main() {
enum Animal {
    Dog(String, f64),
    Cat { name: String, weight: f64 },
}

let mut a: Animal = Animal::Dog("Cocoa".to_string(), 37.2);
a = Animal::Cat { name: "Spotty".to_string(), weight: 2.7 };
}

在此示例中，Cat 是类似结构体的枚举变体，而 Dog 仅称为枚举变体。

没有构造函数包含字段的枚举称为无字段枚举。例如，这是一个无字段枚举

#![allow(unused)]
fn main() {
enum Fieldless {
    Tuple(),
    Struct{},
    Unit,
}
}

如果无字段枚举仅包含单元变体，则该枚举称为仅单元枚举。例如

#![allow(unused)]
fn main() {
enum Enum {
    Foo = 3,
    Bar = 2,
    Baz = 1,
}
}

判别式

每个枚举实例都有一个判别式：一个与其逻辑关联的整数，用于确定它持有的变体。

在默认表示形式下，判别式被解释为 isize 值。但是，编译器可以在其实际内存布局中使用更小的类型（或其他区分变体的方法）。

分配判别式值

显式判别式

在两种情况下，可以通过在变体名称后跟 = 和常量表达式来显式设置变体的判别式

如果枚举是“仅单元”。

如果使用原始表示形式。例如

#![allow(unused)]
fn main() {
#[repr(u8)]
enum Enum {
    Unit = 3,
    Tuple(u16),
    Struct {
        a: u8,
        b: u16,
    } = 1,
}
}

隐式判别式

如果未指定变体的判别式，则将其设置为比声明中前一个变体的判别式高一个。如果未指定声明中第一个变体的判别式，则将其设置为零。

#![allow(unused)]
fn main() {
enum Foo {
    Bar,            // 0
    Baz = 123,      // 123
    Quux,           // 124
}

let baz_discriminant = Foo::Baz as u32;
assert_eq!(baz_discriminant, 123);
}

限制

当两个变体共享相同的判别式时，这是一个错误。

#![allow(unused)]
fn main() {
enum SharedDiscriminantError {
    SharedA = 1,
    SharedB = 1
}

enum SharedDiscriminantError2 {
    Zero,       // 0
    One,        // 1
    OneToo = 1  // 1 (collision with previous!)
}
}

在前一个判别式是判别式大小的最大值的情况下，拥有未指定的判别式也是一个错误。

#![allow(unused)]
fn main() {
#[repr(u8)]
enum OverflowingDiscriminantError {
    Max = 255,
    MaxPlusOne // Would be 256, but that overflows the enum.
}

#[repr(u8)]
enum OverflowingDiscriminantError2 {
    MaxMinusOne = 254, // 254
    Max,               // 255
    MaxPlusOne         // Would be 256, but that overflows the enum.
}
}

访问判别式

通过 `mem::discriminant`

mem::discriminant 返回对可比较的枚举值的判别式的引用。这不能用于获取判别式的值。

类型转换

如果枚举是仅单元（没有元组和结构体变体），则可以使用数值类型转换直接访问其判别式；例如

#![allow(unused)]
fn main() {
enum Enum {
    Foo,
    Bar,
    Baz,
}

assert_eq!(0, Enum::Foo as isize);
assert_eq!(1, Enum::Bar as isize);
assert_eq!(2, Enum::Baz as isize);
}

如果无字段枚举没有显式判别式，或者只有单元变体是显式的，则可以对其进行类型转换。

#![allow(unused)]
fn main() {
enum Fieldless {
    Tuple(),
    Struct{},
    Unit,
}

assert_eq!(0, Fieldless::Tuple() as isize);
assert_eq!(1, Fieldless::Struct{} as isize);
assert_eq!(2, Fieldless::Unit as isize);

#[repr(u8)]
enum FieldlessWithDiscrimants {
    First = 10,
    Tuple(),
    Second = 20,
    Struct{},
    Unit,
}

assert_eq!(10, FieldlessWithDiscrimants::First as u8);
assert_eq!(11, FieldlessWithDiscrimants::Tuple() as u8);
assert_eq!(20, FieldlessWithDiscrimants::Second as u8);
assert_eq!(21, FieldlessWithDiscrimants::Struct{} as u8);
assert_eq!(22, FieldlessWithDiscrimants::Unit as u8);
}

指针类型转换

如果枚举指定了原始表示形式，则可以通过不安全的指针类型转换可靠地访问判别式

#![allow(unused)]
fn main() {
#[repr(u8)]
enum Enum {
    Unit,
    Tuple(bool),
    Struct{a: bool},
}

impl Enum {
    fn discriminant(&self) -> u8 {
        unsafe { *(self as *const Self as *const u8) }
    }
}

let unit_like = Enum::Unit;
let tuple_like = Enum::Tuple(true);
let struct_like = Enum::Struct{a: false};

assert_eq!(0, unit_like.discriminant());
assert_eq!(1, tuple_like.discriminant());
assert_eq!(2, struct_like.discriminant());
}

零变体枚举

具有零个变体的枚举称为零变体枚举。由于它们没有有效值，因此无法实例化。

#![allow(unused)]
fn main() {
enum ZeroVariants {}
}

零变体枚举等效于never 类型，但不能将其强制转换为其他类型。

#![allow(unused)]
fn main() {
enum ZeroVariants {}
let x: ZeroVariants = panic!();
let y: u32 = x; // mismatched type error
}

变体可见性

枚举变体在语法上允许使用可见性注释，但在验证枚举时会拒绝此注释。这允许在使用它们的不用上下文中使用统一语法解析项目。

#![allow(unused)]
fn main() {
macro_rules! mac_variant {
    ($vis:vis $name:ident) => {
        enum $name {
            $vis Unit,

            $vis Tuple(u8, u16),

            $vis Struct { f: u8 },
        }
    }
}

// Empty `vis` is allowed.
mac_variant! { E }

// This is allowed, since it is removed before being validated.
#[cfg(FALSE)]
enum E {
    pub U,
    pub(crate) T(u8),
    pub(super) T { f: String }
}
}

Rust 参考手册