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.

Sign up for GitHub

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

Jump to bottom

Update Rust crate bitflags to v2 #40

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

Update Rust crate bitflags to v2 #40

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 26, 2024

This PR contains the following updates:

Package Type Update Change
bitflags dependencies major 1.2 -> 2.0

Release Notes

bitflags/bitflags (bitflags)

v2.6.0

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.5.0...2.6.0

v2.5.0

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.4.2...2.5.0

v2.4.2

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.4.1...2.4.2

v2.4.1

Compare Source

What's Changed

Full Changelog: bitflags/bitflags@2.4.0...2.4.1

v2.4.0

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.3.3...2.4.0

v2.3.3

Compare Source

Changes to -=

The -= operator was incorrectly changed to truncate bits that didn't correspond to valid flags in 2.3.0. This has
been fixed up so it once again behaves the same as - and difference.

Changes to !

The ! operator previously called Self::from_bits_truncate, which would truncate any bits that only partially
overlapped with a valid flag. It will now use bits & Self::all().bits(), so any bits that overlap any bits
specified by any flag will be respected. This is unlikely to have any practical implications, but enables defining
a flag like const ALL = !0 as a way to signal that any bit pattern is a known set of flags.

Changes to formatting

Zero-valued flags will never be printed. You'll either get 0x0 for empty flags using debug formatting, or the
set of flags with zero-valued flags omitted for others.

Composite flags will no longer be redundantly printed if there are extra bits to print at the end that don't correspond
to a valid flag.

What's Changed

Full Changelog: bitflags/bitflags@2.3.2...2.3.3

v2.3.2

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.3.1...2.3.2

v2.3.1

Compare Source

What's Changed

Full Changelog: bitflags/bitflags@2.3.0...2.3.1

v2.3.0

Compare Source

Major changes

BitFlags trait deprecated in favor of Flags trait

This release introduces the Flags trait and deprecates the BitFlags trait. These two traits are semver compatible so if you have public API code depending on BitFlags you can move to Flags without breaking end-users. This is possible because the BitFlags trait was never publicly implementable, so it now carries Flags as a supertrait. All implementations of Flags additionally implement BitFlags.

The Flags trait is a publicly implementable version of the old BitFlags trait. The original BitFlags trait carried some macro baggage that made it difficult to implement, so a new Flags trait has been introduced as the One True Trait for interacting with flags types generically. See the the macro_free and custom_derive examples for more details.

Bits trait publicly exposed

The Bits trait for the underlying storage of flags values is also now publicly implementable. This lets you define your own exotic backing storage for flags. See the custom_bits_type example for more details.

What's Changed

Full Changelog: bitflags/bitflags@2.2.1...2.3.0

v2.2.1

Compare Source

What's Changed

Full Changelog: bitflags/bitflags@2.2.0...2.2.1

v2.2.0

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.1.0...2.2.0

v2.1.0

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.0.2...2.1.0

v2.0.2

Compare Source

What's Changed

Full Changelog: bitflags/bitflags@2.0.1...2.0.2

v2.0.1

Compare Source

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@2.0.0...2.0.1

v2.0.0

Compare Source

Major changes

This release includes some major changes over 1.x. If you use bitflags! types in your public API then upgrading this library may cause breakage in your downstream users.

⚠️ Serialization

You'll need to add the serde Cargo feature in order to #[derive(Serialize, Deserialize)] on your generated flags types:

bitflags! {
    #[derive(Serialize, Deserialize)]
    #[serde(transparent)]
    pub struct Flags: T {
        ..
    }
}

where T is the underlying bits type you're using, such as u32.

The default serialization format with serde has changed if you #[derive(Serialize, Deserialize)] on your generated flags types. It will now use a formatted string for human-readable formats and the underlying bits type for compact formats.

To keep the old format, see the https://github.com/KodrAus/bitflags-serde-legacy library.

⚠️ Traits

Generated flags types now derive fewer traits. If you need to maintain backwards compatibility, you can derive the following yourself:

#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
⚠️ Methods

The unsafe from_bits_unchecked method is now a safe from_bits_retain method.

You can add the following method to your generated types to keep them compatible:

#[deprecated = "use the safe `from_bits_retain` method instead"]
pub unsafe fn from_bits_unchecked(bits: T) -> Self {
    Self::from_bits_retain(bits)
}

where T is the underlying bits type you're using, such as u32.

⚠️ .bits field

You can now use the .bits() method instead of the old .bits.

The representation of generated flags types has changed from a struct with the single field bits to a newtype.

What's Changed

New Contributors

Full Changelog: bitflags/bitflags@1.3.2...2.0.0

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 this update 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
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants