Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update strum monorepo to 0.26.0 #31

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented May 23, 2024

This PR contains the following updates:

Package Type Update Change
strum dependencies minor 0.19.5 -> 0.26.0
strum_macros dependencies minor 0.19.4 -> 0.26.0
strum_macros dependencies minor 0.20.1 -> 0.26.0

Release Notes

Peternator7/strum (strum)

v0.26.3

Compare Source

  • #​344: Hide EnumTable because it's going to be deprecated in the next
    version.
  • #​357: Fixes an incompatiblity with itertools by using the fully
    qualified name rather than the inherent method.
  • #​345: Allows unnamed tuple like variants to use their variants in
    string interpolation. #[strum(to_string = "Field 0: {0}, Field 1: {1})")] will now work for tuple variants

v0.26.2

Compare Source

  • #​337: Fix missing generic impls for EnumTryAs
  • #​334: Support prefix in AsRefStr. Technically a breaking change,
    but prefix was just added in 0.26.0 so it's a newer feature and it makes the feature more consisent in general.

v0.26.1

  • #​325: use core instead of std in VariantArray.

v0.26.0

Breaking Changes
  • The EnumVariantNames macro has been renamed VariantNames. The deprecation warning should steer you in
    the right direction for fixing the warning.
  • The Iterator struct generated by EnumIter now has new bounds on it. This shouldn't break code unless you manually
    added the implementation in your code.
  • Display now supports format strings using named fields in the enum variant. This should be a no-op for most code.
    However, if you were outputting a string like "Hello {field}", this will now be interpretted as a format string.
  • EnumDiscriminant now inherits the repr and discriminant values from your main enum. This makes the discriminant type
    closer to a mirror of the original and that's always the goal.
New features
  • The VariantArray macro has been added. This macro adds an associated constant VARIANTS to your enum. The constant
    is a &'static [Self] slice so that you can access all the variants of your enum. This only works on enums that only
    have unit variants.

    use strum::VariantArray;
    
    #[derive(Debug, VariantArray)]
    enum Color {
      Red,
      Blue,
      Green,
    }
    
    fn main() {
      println!("{:?}", Color::VARIANTS); // prints: ["Red", "Blue", "Green"]
    }
  • The EnumTable macro has been experimentally added. This macro adds a new type that stores an item for each variant
    of the enum. This is useful for storing a value for each variant of an enum. This is an experimental feature because
    I'm not convinced the current api surface area is correct.

    use strum::EnumTable;
    
    #[derive(Copy, Clone, Debug, EnumTable)]
    enum Color {
      Red,
      Blue,
      Green,
    }
    
    fn main() {
      let mut counts = ColorTable::filled(0);
      for color in &[Color::Red, Color::Red, Color::Green]] {
        counts[color] += 1;
      }
    
      assert_eq!(counts[Color::Red], 2);
      assert_eq!(counts[Color::Blue], 0);
      assert_eq!(counts[Color::Green], 1);
    }
  • Display has 2 new features:

    • the strum(prefix = "some_value") attribute on an enum now allows you to prepend a string onto every
      variant when you serialize it.

    • Custom to_string and serialize attributes now support string interopolation on serialization.

PR's Merged
  • #​322: avoid collisions on std::fmt::Debug
  • #​321: avoid conflicts with consecutive underscores.
  • #​314: add additional bounds to EnumIterator
  • #​311: add FusedIterator bounds to EnumIterator
  • #​297: New macro, add VariantArray
  • #​296: adds prefix attribute to To/From String macros.
  • #​294: use named enum fields in to_string macro.
  • #​288: discriminant enums now inherit the repr from the original enum.
  • #​279: Add EnumTable macro to generate a mapping between fieldless variants and data.

v0.25.0

Breaking Changes
  • #​261 Upgrade syn dependency to version 2. This bumps the msrv to
    1.56. It's impractical to maintain a package where a core dependency of the ecosystem has a different msrv than this one.

  • 270 Change the to_string behavior when using default. Now, when
    using default, the display method will return the display version of the value contained in the enum rather than
    the name of the variant.

    #[derive(strum::Display)]
    enum Color {
      Red,
      Blue,
      Green,
      #[strum(default)]
      Other(String)
    }
    
    fn main() {
      // This used to print "Other", now it prints "Purple"
      assert_eq!(Color::Other("Purple".to_string()).to_string(), "Purple");
    }

    If you want the old behavior, you can use the to_string attribute to override this behavior. See the PR for an example.

  • 268 Update the behavior of EnumCount to exclude variants that are
    disabled. This is a breaking change, but the behavior makes it more consistent with other methods.

New Features
  • #​257 This PR adds the EnumIs macro that automatically implements
    is_{variant_name} methods for each variant.

    #[derive(EnumIs)]
    enum Color {
        Red,
        Blue,
        Green,
    }
    
    #[test]
    fn simple_test() {
        assert!(Color::Red.is_red());
    }

v0.24.1

  • #​220. Add support for PHF in EnumString (opt-in runtime
    performance improvements for large enums as #[strum(use_phf)], requires phf feature and increases MSRV to 1.46)
  • #​217: Automatically implement TryFrom in FromRepr. This is
    technically a breaking change, but the fix is to just remove the manual implementation of TryFrom so it shouldn't
    be more than a minor inconvenience.

v0.24.0

  • #​212. Fix some clippy lints

  • #​209. Use core instead of std in a few places.

  • #​206. Add get_documentation() to EnumMessage. This provides
    the ability to get the doc comment for a variant. Currently, very little formatting is done. That is subject to change.
    Please do not abuse this feature. Rust docs are meant for developer documentation, not long messages for users. However,
    this may be useful in some situations so we've added support for it.

  • #​202. Add a missing doc comment

  • #​201. Upgrade Heck version

v0.23.0

  • #​185 Adds the FromRepr derive that adds a from_repr(x: usize) -> Option<Self>
    method to your enum. This lets you convert integer values to your enum. If you specify a #[repr(..)] attribute on your enum, or use
    an explicit discriminant, this will be incorporated into the derive.

    • from_repr will be const if you use a recent rust version.
    • This cannot be a trait method currently because only inherent methods support const.
  • #​186 Automatically implement TryFrom<str> for enums that implement EnumString.
    This is only enabled for rustc >= 1.34 which is when `TryFrom was stabilized.

    • This is a small breaking change. If you had manually implemented TryFrom<str> for your enum, this will cause a conflict. You
      can probably remove your manual implementation.
  • #​189 Use core::result::Result instead of std::result::Result. This should be
    more portable in no-std environments.

v0.22.0

  • #​180: Deprecates ToString derive. You should use Display
    instead.

  • #​178: Deprecates AsStaticStr. This has been undocumented for a while.
    The recommended method is to derive IntoStaticStr instead.

  • #​171: Improve no-std support.

  • #​170: enable changing the path to strum traits. This is necessary
    if you re-export strum as a submodule in another crate.

v0.21.0

  • Replace std:: with core:: to support no-std projects. #​145

  • Breaking Changes

    • MSRV is updated to 1.32 because heck does not work in 1.31.1 anymore. Rust 1.32 came out Jan 2019 so hopefully
      teams have moved to an equal or newer version.
    • #​149 Remove the "rename" feature. In Rust 2018, macros should be
      imported using a qualified path to avoid collisions. strum_macros::EnumString rather than using the "Rename"
      feature to avoid collisions.
    • #​160 enum messages: Make the returned values all 'static
      • It is unlikely this will break anyone, but the new signature for functions generated by EnumMessage
        is fn get_message(&self) -> Option<&'static str>.
  • Added support for ascii_case_insensitive string comparisons. #​157
    This feature allows FromString impls to match strings that differ in case from the expected variant.

v0.20.0

  • Refactors to do better error handling. Thanks @​jplatte for these changes

  • Adding vis(scope) to EnumDiscriminants. #​137

    • This feature works best with versions of rust >= 1.34 due to a rustc parsing error in
      earlier versions.
    • Earlier versions can still use vis(r#pub)
  • These changes should not be breaking, but the amount of code modified was significant.

  • FYI about #​122. The macro renames feature
    will be removed in early 2021. This feature was only necessary in rust 2015 because macros
    didn't support qualified imports so macro names could collide between crates.


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants