compiler/rustc_span/src/edition.rs

   1 use crate::symbol::{sym, Symbol};
   2 use std::fmt;
   3 use std::str::FromStr;
   4
   5 use rustc_macros::HashStable_Generic;
   6
   7 /// The edition of the compiler. (See [RFC 2052](https://github.com/rust-lang/rfcs/blob/master/text/2052-epochs.md).)
   8 #[derive(Clone, Copy, Hash, PartialEq, PartialOrd, Debug, Encodable, Decodable, Eq)]
   9 #[derive(HashStable_Generic)]
  10 pub enum Edition {
  11     // When adding new editions, be sure to do the following:
  12     //
  13     // - update the `ALL_EDITIONS` const
  14     // - update the `EDITION_NAME_LIST` const
  15     // - add a `rust_####()` function to the session
  16     // - update the enum in Cargo's sources as well
  17     //
  18     // Editions *must* be kept in order, oldest to newest.
  19     /// The 2015 edition
  20     Edition2015,
  21     /// The 2018 edition
  22     Edition2018,
  23     /// The 2021 edition
  24     Edition2021,
  25     /// The 2024 edition
  26     Edition2024,
  27 }
  28
  29 // Must be in order from oldest to newest.
  30 pub const ALL_EDITIONS: &[Edition] =
  31     &[Edition::Edition2015, Edition::Edition2018, Edition::Edition2021, Edition::Edition2024];
  32
  33 pub const EDITION_NAME_LIST: &str = "2015|2018|2021|2024";
  34
  35 pub const DEFAULT_EDITION: Edition = Edition::Edition2015;
  36
  37 pub const LATEST_STABLE_EDITION: Edition = Edition::Edition2021;
  38
  39 impl fmt::Display for Edition {
  40     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  41         let s = match *self {
  42             Edition::Edition2015 => "2015",
  43             Edition::Edition2018 => "2018",
  44             Edition::Edition2021 => "2021",
  45             Edition::Edition2024 => "2024",
  46         };
  47         write!(f, "{s}")
  48     }
  49 }
  50
  51 impl Edition {
  52     pub fn lint_name(&self) -> &'static str {
  53         match *self {
  54             Edition::Edition2015 => "rust_2015_compatibility",
  55             Edition::Edition2018 => "rust_2018_compatibility",
  56             Edition::Edition2021 => "rust_2021_compatibility",
  57             Edition::Edition2024 => "rust_2024_compatibility",
  58         }
  59     }
  60
  61     pub fn feature_name(&self) -> Symbol {
  62         match *self {
  63             Edition::Edition2015 => sym::rust_2015_preview,
  64             Edition::Edition2018 => sym::rust_2018_preview,
  65             Edition::Edition2021 => sym::rust_2021_preview,
  66             Edition::Edition2024 => sym::rust_2024_preview,
  67         }
  68     }
  69
  70     pub fn is_stable(&self) -> bool {
  71         match *self {
  72             Edition::Edition2015 => true,
  73             Edition::Edition2018 => true,
  74             Edition::Edition2021 => true,
  75             Edition::Edition2024 => false,
  76         }
  77     }
  78
  79     /// Is this edition 2015?
  80     pub fn rust_2015(&self) -> bool {
  81         *self == Edition::Edition2015
  82     }
  83
  84     /// Are we allowed to use features from the Rust 2018 edition?
  85     pub fn rust_2018(&self) -> bool {
  86         *self >= Edition::Edition2018
  87     }
  88
  89     /// Are we allowed to use features from the Rust 2021 edition?
  90     pub fn rust_2021(&self) -> bool {
  91         *self >= Edition::Edition2021
  92     }
  93
  94     /// Are we allowed to use features from the Rust 2024 edition?
  95     pub fn rust_2024(&self) -> bool {
  96         *self >= Edition::Edition2024
  97     }
  98 }
  99
 100 impl FromStr for Edition {
 101     type Err = ();
 102     fn from_str(s: &str) -> Result<Self, ()> {
 103         match s {
 104             "2015" => Ok(Edition::Edition2015),
 105             "2018" => Ok(Edition::Edition2018),
 106             "2021" => Ok(Edition::Edition2021),
 107             "2024" => Ok(Edition::Edition2024),
 108             _ => Err(()),
 109         }
 110     }
 111 }