Initial vendor packages
Signed-off-by: Valentin Popov <valentin@popov.link>
This commit is contained in:
		
							
								
								
									
										65
									
								
								vendor/bitflags/src/example_generated.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										65
									
								
								vendor/bitflags/src/example_generated.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,65 @@
 | 
			
		||||
//! This module shows an example of code generated by the macro. **IT MUST NOT BE USED OUTSIDE THIS
 | 
			
		||||
//! CRATE**.
 | 
			
		||||
//!
 | 
			
		||||
//! Usually, when you call the `bitflags!` macro, only the `Flags` type would be visible. In this
 | 
			
		||||
//! example, the `Field0`, `Iter`, and `IterRaw` types are also exposed so that you can explore
 | 
			
		||||
//! their APIs. The `Field0` type can be accessed as `self.0` on an instance of `Flags`.
 | 
			
		||||
 | 
			
		||||
__declare_public_bitflags! {
 | 
			
		||||
    /// This is the same `Flags` struct defined in the [crate level example](../index.html#example).
 | 
			
		||||
    /// Note that this struct is just for documentation purposes only, it must not be used outside
 | 
			
		||||
    /// this crate.
 | 
			
		||||
    pub struct Flags
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__declare_internal_bitflags! {
 | 
			
		||||
    pub struct Field0: u32
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__impl_internal_bitflags! {
 | 
			
		||||
    Field0: u32, Flags {
 | 
			
		||||
        // Field `A`.
 | 
			
		||||
        ///
 | 
			
		||||
        /// This flag has the value `0b00000001`.
 | 
			
		||||
        const A = 0b00000001;
 | 
			
		||||
        /// Field `B`.
 | 
			
		||||
        ///
 | 
			
		||||
        /// This flag has the value `0b00000010`.
 | 
			
		||||
        const B = 0b00000010;
 | 
			
		||||
        /// Field `C`.
 | 
			
		||||
        ///
 | 
			
		||||
        /// This flag has the value `0b00000100`.
 | 
			
		||||
        const C = 0b00000100;
 | 
			
		||||
        const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__impl_public_bitflags_forward! {
 | 
			
		||||
    Flags: u32, Field0
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__impl_public_bitflags_ops! {
 | 
			
		||||
    Flags
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__impl_public_bitflags_iter! {
 | 
			
		||||
    Flags: u32, Flags
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__impl_public_bitflags_consts! {
 | 
			
		||||
    Flags: u32 {
 | 
			
		||||
        /// Field `A`.
 | 
			
		||||
        ///
 | 
			
		||||
        /// This flag has the value `0b00000001`.
 | 
			
		||||
        const A = 0b00000001;
 | 
			
		||||
        /// Field `B`.
 | 
			
		||||
        ///
 | 
			
		||||
        /// This flag has the value `0b00000010`.
 | 
			
		||||
        const B = 0b00000010;
 | 
			
		||||
        /// Field `C`.
 | 
			
		||||
        ///
 | 
			
		||||
        /// This flag has the value `0b00000100`.
 | 
			
		||||
        const C = 0b00000100;
 | 
			
		||||
        const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										262
									
								
								vendor/bitflags/src/external.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										262
									
								
								vendor/bitflags/src/external.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,262 @@
 | 
			
		||||
//! Conditional trait implementations for external libraries.
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
How do I support a new external library?
 | 
			
		||||
 | 
			
		||||
Let's say we want to add support for `my_library`.
 | 
			
		||||
 | 
			
		||||
First, we create a module under `external`, like `serde` with any specialized code.
 | 
			
		||||
Ideally, any utilities in here should just work off the `Flags` trait and maybe a
 | 
			
		||||
few other assumed bounds.
 | 
			
		||||
 | 
			
		||||
Next, re-export the library from the `__private` module here.
 | 
			
		||||
 | 
			
		||||
Next, define a macro like so:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(feature = "serde")]
 | 
			
		||||
macro_rules! __impl_external_bitflags_my_library {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        // Implementation goes here
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(not(feature = "my_library"))]
 | 
			
		||||
macro_rules! __impl_external_bitflags_my_library {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {};
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Note that the macro is actually defined twice; once for when the `my_library` feature
 | 
			
		||||
is available, and once for when it's not. This is because the `__impl_external_bitflags_my_library`
 | 
			
		||||
macro is called in an end-user's library, not in `bitflags`. In an end-user's library we don't
 | 
			
		||||
know whether or not a particular feature of `bitflags` is enabled, so we unconditionally call
 | 
			
		||||
the macro, where the body of that macro depends on the feature flag.
 | 
			
		||||
 | 
			
		||||
Now, we add our macro call to the `__impl_external_bitflags` macro body:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
__impl_external_bitflags_my_library! {
 | 
			
		||||
    $InternalBitFlags: $T, $PublicBitFlags {
 | 
			
		||||
        $(
 | 
			
		||||
            $(#[$inner $($args)*])*
 | 
			
		||||
            const $Flag;
 | 
			
		||||
        )*
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
pub(crate) mod __private {
 | 
			
		||||
    #[cfg(feature = "serde")]
 | 
			
		||||
    pub use serde;
 | 
			
		||||
 | 
			
		||||
    #[cfg(feature = "arbitrary")]
 | 
			
		||||
    pub use arbitrary;
 | 
			
		||||
 | 
			
		||||
    #[cfg(feature = "bytemuck")]
 | 
			
		||||
    pub use bytemuck;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implements traits from external libraries for the internal bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_external_bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        // Any new library traits impls should be added here
 | 
			
		||||
        // Use `serde` as an example: generate code when the feature is available,
 | 
			
		||||
        // and a no-op when it isn't
 | 
			
		||||
 | 
			
		||||
        __impl_external_bitflags_serde! {
 | 
			
		||||
            $InternalBitFlags: $T, $PublicBitFlags {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner $($args)*])*
 | 
			
		||||
                    const $Flag;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        __impl_external_bitflags_arbitrary! {
 | 
			
		||||
            $InternalBitFlags: $T, $PublicBitFlags {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner $($args)*])*
 | 
			
		||||
                    const $Flag;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        __impl_external_bitflags_bytemuck! {
 | 
			
		||||
            $InternalBitFlags: $T, $PublicBitFlags {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner $($args)*])*
 | 
			
		||||
                    const $Flag;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[cfg(feature = "serde")]
 | 
			
		||||
pub mod serde;
 | 
			
		||||
 | 
			
		||||
/// Implement `Serialize` and `Deserialize` for the internal bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(feature = "serde")]
 | 
			
		||||
macro_rules! __impl_external_bitflags_serde {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        impl $crate::__private::serde::Serialize for $InternalBitFlags {
 | 
			
		||||
            fn serialize<S: $crate::__private::serde::Serializer>(
 | 
			
		||||
                &self,
 | 
			
		||||
                serializer: S,
 | 
			
		||||
            ) -> $crate::__private::core::result::Result<S::Ok, S::Error> {
 | 
			
		||||
                $crate::serde::serialize(
 | 
			
		||||
                    &$PublicBitFlags::from_bits_retain(self.bits()),
 | 
			
		||||
                    serializer,
 | 
			
		||||
                )
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl<'de> $crate::__private::serde::Deserialize<'de> for $InternalBitFlags {
 | 
			
		||||
            fn deserialize<D: $crate::__private::serde::Deserializer<'de>>(
 | 
			
		||||
                deserializer: D,
 | 
			
		||||
            ) -> $crate::__private::core::result::Result<Self, D::Error> {
 | 
			
		||||
                let flags: $PublicBitFlags = $crate::serde::deserialize(deserializer)?;
 | 
			
		||||
 | 
			
		||||
                Ok(flags.0)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(not(feature = "serde"))]
 | 
			
		||||
macro_rules! __impl_external_bitflags_serde {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {};
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[cfg(feature = "arbitrary")]
 | 
			
		||||
pub mod arbitrary;
 | 
			
		||||
 | 
			
		||||
#[cfg(feature = "bytemuck")]
 | 
			
		||||
mod bytemuck;
 | 
			
		||||
 | 
			
		||||
/// Implement `Arbitrary` for the internal bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(feature = "arbitrary")]
 | 
			
		||||
macro_rules! __impl_external_bitflags_arbitrary {
 | 
			
		||||
    (
 | 
			
		||||
            $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                    const $Flag:tt;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
    ) => {
 | 
			
		||||
        impl<'a> $crate::__private::arbitrary::Arbitrary<'a> for $InternalBitFlags {
 | 
			
		||||
            fn arbitrary(
 | 
			
		||||
                u: &mut $crate::__private::arbitrary::Unstructured<'a>,
 | 
			
		||||
            ) -> $crate::__private::arbitrary::Result<Self> {
 | 
			
		||||
                $crate::arbitrary::arbitrary::<$PublicBitFlags>(u).map(|flags| flags.0)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(not(feature = "arbitrary"))]
 | 
			
		||||
macro_rules! __impl_external_bitflags_arbitrary {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {};
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement `Pod` and `Zeroable` for the internal bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(feature = "bytemuck")]
 | 
			
		||||
macro_rules! __impl_external_bitflags_bytemuck {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        // SAFETY: $InternalBitFlags is guaranteed to have the same ABI as $T,
 | 
			
		||||
        // and $T implements Pod
 | 
			
		||||
        unsafe impl $crate::__private::bytemuck::Pod for $InternalBitFlags where
 | 
			
		||||
            $T: $crate::__private::bytemuck::Pod
 | 
			
		||||
        {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // SAFETY: $InternalBitFlags is guaranteed to have the same ABI as $T,
 | 
			
		||||
        // and $T implements Zeroable
 | 
			
		||||
        unsafe impl $crate::__private::bytemuck::Zeroable for $InternalBitFlags where
 | 
			
		||||
            $T: $crate::__private::bytemuck::Zeroable
 | 
			
		||||
        {
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[cfg(not(feature = "bytemuck"))]
 | 
			
		||||
macro_rules! __impl_external_bitflags_bytemuck {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {};
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										33
									
								
								vendor/bitflags/src/external/arbitrary.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								vendor/bitflags/src/external/arbitrary.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,33 @@
 | 
			
		||||
//! Specialized fuzzing for flags types using `arbitrary`.
 | 
			
		||||
 | 
			
		||||
use crate::Flags;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Generate some arbitrary flags value with only known bits set.
 | 
			
		||||
*/
 | 
			
		||||
pub fn arbitrary<'a, B: Flags>(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<B>
 | 
			
		||||
where
 | 
			
		||||
    B::Bits: arbitrary::Arbitrary<'a>,
 | 
			
		||||
{
 | 
			
		||||
    B::from_bits(u.arbitrary()?).ok_or_else(|| arbitrary::Error::IncorrectFormat)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[cfg(test)]
 | 
			
		||||
mod tests {
 | 
			
		||||
    use arbitrary::Arbitrary;
 | 
			
		||||
 | 
			
		||||
    bitflags! {
 | 
			
		||||
        #[derive(Arbitrary)]
 | 
			
		||||
        struct Color: u32 {
 | 
			
		||||
            const RED = 0x1;
 | 
			
		||||
            const GREEN = 0x2;
 | 
			
		||||
            const BLUE = 0x4;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[test]
 | 
			
		||||
    fn test_arbitrary() {
 | 
			
		||||
        let mut unstructured = arbitrary::Unstructured::new(&[0_u8; 256]);
 | 
			
		||||
        let _color = Color::arbitrary(&mut unstructured);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										19
									
								
								vendor/bitflags/src/external/bytemuck.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								vendor/bitflags/src/external/bytemuck.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,19 @@
 | 
			
		||||
#[cfg(test)]
 | 
			
		||||
mod tests {
 | 
			
		||||
    use bytemuck::{Pod, Zeroable};
 | 
			
		||||
 | 
			
		||||
    bitflags! {
 | 
			
		||||
        #[derive(Pod, Zeroable, Clone, Copy)]
 | 
			
		||||
        #[repr(transparent)]
 | 
			
		||||
        struct Color: u32 {
 | 
			
		||||
            const RED = 0x1;
 | 
			
		||||
            const GREEN = 0x2;
 | 
			
		||||
            const BLUE = 0x4;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[test]
 | 
			
		||||
    fn test_bytemuck() {
 | 
			
		||||
        assert_eq!(0x1, bytemuck::cast::<Color, u32>(Color::RED));
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										93
									
								
								vendor/bitflags/src/external/serde.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										93
									
								
								vendor/bitflags/src/external/serde.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,93 @@
 | 
			
		||||
//! Specialized serialization for flags types using `serde`.
 | 
			
		||||
 | 
			
		||||
use crate::{
 | 
			
		||||
    parser::{self, ParseHex, WriteHex},
 | 
			
		||||
    Flags,
 | 
			
		||||
};
 | 
			
		||||
use core::{fmt, str};
 | 
			
		||||
use serde::{
 | 
			
		||||
    de::{Error, Visitor},
 | 
			
		||||
    Deserialize, Deserializer, Serialize, Serializer,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Serialize a set of flags as a human-readable string or their underlying bits.
 | 
			
		||||
 | 
			
		||||
Any unknown bits will be retained.
 | 
			
		||||
*/
 | 
			
		||||
pub fn serialize<B: Flags, S: Serializer>(flags: &B, serializer: S) -> Result<S::Ok, S::Error>
 | 
			
		||||
where
 | 
			
		||||
    B::Bits: WriteHex + Serialize,
 | 
			
		||||
{
 | 
			
		||||
    // Serialize human-readable flags as a string like `"A | B"`
 | 
			
		||||
    if serializer.is_human_readable() {
 | 
			
		||||
        serializer.collect_str(&parser::AsDisplay(flags))
 | 
			
		||||
    }
 | 
			
		||||
    // Serialize non-human-readable flags directly as the underlying bits
 | 
			
		||||
    else {
 | 
			
		||||
        flags.bits().serialize(serializer)
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Deserialize a set of flags from a human-readable string or their underlying bits.
 | 
			
		||||
 | 
			
		||||
Any unknown bits will be retained.
 | 
			
		||||
*/
 | 
			
		||||
pub fn deserialize<'de, B: Flags, D: Deserializer<'de>>(deserializer: D) -> Result<B, D::Error>
 | 
			
		||||
where
 | 
			
		||||
    B::Bits: ParseHex + Deserialize<'de>,
 | 
			
		||||
{
 | 
			
		||||
    if deserializer.is_human_readable() {
 | 
			
		||||
        // Deserialize human-readable flags by parsing them from strings like `"A | B"`
 | 
			
		||||
        struct FlagsVisitor<B>(core::marker::PhantomData<B>);
 | 
			
		||||
 | 
			
		||||
        impl<'de, B: Flags> Visitor<'de> for FlagsVisitor<B>
 | 
			
		||||
        where
 | 
			
		||||
            B::Bits: ParseHex,
 | 
			
		||||
        {
 | 
			
		||||
            type Value = B;
 | 
			
		||||
 | 
			
		||||
            fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
 | 
			
		||||
                formatter.write_str("a string value of `|` separated flags")
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            fn visit_str<E: Error>(self, flags: &str) -> Result<Self::Value, E> {
 | 
			
		||||
                parser::from_str(flags).map_err(|e| E::custom(e))
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        deserializer.deserialize_str(FlagsVisitor(Default::default()))
 | 
			
		||||
    } else {
 | 
			
		||||
        // Deserialize non-human-readable flags directly from the underlying bits
 | 
			
		||||
        let bits = B::Bits::deserialize(deserializer)?;
 | 
			
		||||
 | 
			
		||||
        Ok(B::from_bits_retain(bits))
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[cfg(test)]
 | 
			
		||||
mod tests {
 | 
			
		||||
    use serde_test::{assert_tokens, Configure, Token::*};
 | 
			
		||||
    bitflags! {
 | 
			
		||||
        #[derive(serde_derive::Serialize, serde_derive::Deserialize, Debug, PartialEq, Eq)]
 | 
			
		||||
        #[serde(transparent)]
 | 
			
		||||
        struct SerdeFlags: u32 {
 | 
			
		||||
            const A = 1;
 | 
			
		||||
            const B = 2;
 | 
			
		||||
            const C = 4;
 | 
			
		||||
            const D = 8;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[test]
 | 
			
		||||
    fn test_serde_bitflags_default() {
 | 
			
		||||
        assert_tokens(&SerdeFlags::empty().readable(), &[Str("")]);
 | 
			
		||||
 | 
			
		||||
        assert_tokens(&SerdeFlags::empty().compact(), &[U32(0)]);
 | 
			
		||||
 | 
			
		||||
        assert_tokens(&(SerdeFlags::A | SerdeFlags::B).readable(), &[Str("A | B")]);
 | 
			
		||||
 | 
			
		||||
        assert_tokens(&(SerdeFlags::A | SerdeFlags::B).compact(), &[U32(1 | 2)]);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										125
									
								
								vendor/bitflags/src/internal.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										125
									
								
								vendor/bitflags/src/internal.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,125 @@
 | 
			
		||||
//! Generate the internal `bitflags`-facing flags type.
 | 
			
		||||
//!
 | 
			
		||||
//! The code generated here is owned by `bitflags`, but still part of its public API.
 | 
			
		||||
//! Changes to the types generated here need to be considered like any other public API change.
 | 
			
		||||
 | 
			
		||||
/// Declare the `bitflags`-facing bitflags struct.
 | 
			
		||||
///
 | 
			
		||||
/// This type is part of the `bitflags` crate's public API, but not part of the user's.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __declare_internal_bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $vis:vis struct $InternalBitFlags:ident: $T:ty
 | 
			
		||||
    ) => {
 | 
			
		||||
        // NOTE: The ABI of this type is _guaranteed_ to be the same as `T`
 | 
			
		||||
        // This is relied on by some external libraries like `bytemuck` to make
 | 
			
		||||
        // its `unsafe` trait impls sound.
 | 
			
		||||
        #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
 | 
			
		||||
        #[repr(transparent)]
 | 
			
		||||
        $vis struct $InternalBitFlags($T);
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement functions on the private (bitflags-facing) bitflags type.
 | 
			
		||||
///
 | 
			
		||||
/// Methods and trait implementations can be freely added here without breaking end-users.
 | 
			
		||||
/// If we want to expose new functionality to `#[derive]`, this is the place to do it.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_internal_bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $InternalBitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt = $value:expr;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        // NOTE: This impl is also used to prevent using bits types from non-primitive types
 | 
			
		||||
        // in the `bitflags` macro. If this approach is changed, this guard will need to be
 | 
			
		||||
        // retained somehow
 | 
			
		||||
        impl $crate::__private::PublicFlags for $PublicBitFlags {
 | 
			
		||||
            type Primitive = $T;
 | 
			
		||||
            type Internal = $InternalBitFlags;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::default::Default for $InternalBitFlags {
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn default() -> Self {
 | 
			
		||||
                $InternalBitFlags::empty()
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::fmt::Debug for $InternalBitFlags {
 | 
			
		||||
            fn fmt(&self, f: &mut $crate::__private::core::fmt::Formatter<'_>) -> $crate::__private::core::fmt::Result {
 | 
			
		||||
                if self.is_empty() {
 | 
			
		||||
                    // If no flags are set then write an empty hex flag to avoid
 | 
			
		||||
                    // writing an empty string. In some contexts, like serialization,
 | 
			
		||||
                    // an empty string is preferable, but it may be unexpected in
 | 
			
		||||
                    // others for a format not to produce any output.
 | 
			
		||||
                    //
 | 
			
		||||
                    // We can remove this `0x0` and remain compatible with `FromStr`,
 | 
			
		||||
                    // because an empty string will still parse to an empty set of flags,
 | 
			
		||||
                    // just like `0x0` does.
 | 
			
		||||
                    $crate::__private::core::write!(f, "{:#x}", <$T as $crate::Bits>::EMPTY)
 | 
			
		||||
                } else {
 | 
			
		||||
                    $crate::__private::core::fmt::Display::fmt(self, f)
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::fmt::Display for $InternalBitFlags {
 | 
			
		||||
            fn fmt(&self, f: &mut $crate::__private::core::fmt::Formatter<'_>) -> $crate::__private::core::fmt::Result {
 | 
			
		||||
                $crate::parser::to_writer(&$PublicBitFlags(*self), f)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::str::FromStr for $InternalBitFlags {
 | 
			
		||||
            type Err = $crate::parser::ParseError;
 | 
			
		||||
 | 
			
		||||
            fn from_str(s: &str) -> $crate::__private::core::result::Result<Self, Self::Err> {
 | 
			
		||||
                $crate::parser::from_str::<$PublicBitFlags>(s).map(|flags| flags.0)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::convert::AsRef<$T> for $InternalBitFlags {
 | 
			
		||||
            fn as_ref(&self) -> &$T {
 | 
			
		||||
                &self.0
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::convert::From<$T> for $InternalBitFlags {
 | 
			
		||||
            fn from(bits: $T) -> Self {
 | 
			
		||||
                Self::from_bits_retain(bits)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // The internal flags type offers a similar API to the public one
 | 
			
		||||
 | 
			
		||||
        __impl_public_bitflags! {
 | 
			
		||||
            $InternalBitFlags: $T, $PublicBitFlags {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner $($args)*])*
 | 
			
		||||
                    const $Flag = $value;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        __impl_public_bitflags_ops! {
 | 
			
		||||
            $InternalBitFlags
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        __impl_public_bitflags_iter! {
 | 
			
		||||
            $InternalBitFlags: $T, $PublicBitFlags
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $InternalBitFlags {
 | 
			
		||||
            /// Returns a mutable reference to the raw value of the flags currently stored.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub fn bits_mut(&mut self) -> &mut $T {
 | 
			
		||||
                &mut self.0
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										145
									
								
								vendor/bitflags/src/iter.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										145
									
								
								vendor/bitflags/src/iter.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,145 @@
 | 
			
		||||
/*!
 | 
			
		||||
Yield the bits of a source flags value in a set of contained flags values.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
use crate::{Flag, Flags};
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
An iterator over flags values.
 | 
			
		||||
 | 
			
		||||
This iterator will yield flags values for contained, defined flags first, with any remaining bits yielded
 | 
			
		||||
as a final flags value.
 | 
			
		||||
*/
 | 
			
		||||
pub struct Iter<B: 'static> {
 | 
			
		||||
    inner: IterNames<B>,
 | 
			
		||||
    done: bool,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: Flags> Iter<B> {
 | 
			
		||||
    pub(crate) fn new(flags: &B) -> Self {
 | 
			
		||||
        Iter {
 | 
			
		||||
            inner: IterNames::new(flags),
 | 
			
		||||
            done: false,
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: 'static> Iter<B> {
 | 
			
		||||
    // Used by the `bitflags` macro
 | 
			
		||||
    #[doc(hidden)]
 | 
			
		||||
    pub const fn __private_const_new(flags: &'static [Flag<B>], source: B, remaining: B) -> Self {
 | 
			
		||||
        Iter {
 | 
			
		||||
            inner: IterNames::__private_const_new(flags, source, remaining),
 | 
			
		||||
            done: false,
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: Flags> Iterator for Iter<B> {
 | 
			
		||||
    type Item = B;
 | 
			
		||||
 | 
			
		||||
    fn next(&mut self) -> Option<Self::Item> {
 | 
			
		||||
        match self.inner.next() {
 | 
			
		||||
            Some((_, flag)) => Some(flag),
 | 
			
		||||
            None if !self.done => {
 | 
			
		||||
                self.done = true;
 | 
			
		||||
 | 
			
		||||
                // After iterating through valid names, if there are any bits left over
 | 
			
		||||
                // then return one final value that includes them. This makes `into_iter`
 | 
			
		||||
                // and `from_iter` roundtrip
 | 
			
		||||
                if !self.inner.remaining().is_empty() {
 | 
			
		||||
                    Some(B::from_bits_retain(self.inner.remaining.bits()))
 | 
			
		||||
                } else {
 | 
			
		||||
                    None
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
            None => None,
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
An iterator over flags values.
 | 
			
		||||
 | 
			
		||||
This iterator only yields flags values for contained, defined, named flags. Any remaining bits
 | 
			
		||||
won't be yielded, but can be found with the [`IterNames::remaining`] method.
 | 
			
		||||
*/
 | 
			
		||||
pub struct IterNames<B: 'static> {
 | 
			
		||||
    flags: &'static [Flag<B>],
 | 
			
		||||
    idx: usize,
 | 
			
		||||
    source: B,
 | 
			
		||||
    remaining: B,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: Flags> IterNames<B> {
 | 
			
		||||
    pub(crate) fn new(flags: &B) -> Self {
 | 
			
		||||
        IterNames {
 | 
			
		||||
            flags: B::FLAGS,
 | 
			
		||||
            idx: 0,
 | 
			
		||||
            remaining: B::from_bits_retain(flags.bits()),
 | 
			
		||||
            source: B::from_bits_retain(flags.bits()),
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: 'static> IterNames<B> {
 | 
			
		||||
    // Used by the bitflags macro
 | 
			
		||||
    #[doc(hidden)]
 | 
			
		||||
    pub const fn __private_const_new(flags: &'static [Flag<B>], source: B, remaining: B) -> Self {
 | 
			
		||||
        IterNames {
 | 
			
		||||
            flags,
 | 
			
		||||
            idx: 0,
 | 
			
		||||
            remaining,
 | 
			
		||||
            source,
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Get a flags value of any remaining bits that haven't been yielded yet.
 | 
			
		||||
    ///
 | 
			
		||||
    /// Once the iterator has finished, this method can be used to
 | 
			
		||||
    /// check whether or not there are any bits that didn't correspond
 | 
			
		||||
    /// to a contained, defined, named flag remaining.
 | 
			
		||||
    pub fn remaining(&self) -> &B {
 | 
			
		||||
        &self.remaining
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: Flags> Iterator for IterNames<B> {
 | 
			
		||||
    type Item = (&'static str, B);
 | 
			
		||||
 | 
			
		||||
    fn next(&mut self) -> Option<Self::Item> {
 | 
			
		||||
        while let Some(flag) = self.flags.get(self.idx) {
 | 
			
		||||
            // Short-circuit if our state is empty
 | 
			
		||||
            if self.remaining.is_empty() {
 | 
			
		||||
                return None;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            self.idx += 1;
 | 
			
		||||
 | 
			
		||||
            // Skip unnamed flags
 | 
			
		||||
            if flag.name().is_empty() {
 | 
			
		||||
                continue;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            let bits = flag.value().bits();
 | 
			
		||||
 | 
			
		||||
            // If the flag is set in the original source _and_ it has bits that haven't
 | 
			
		||||
            // been covered by a previous flag yet then yield it. These conditions cover
 | 
			
		||||
            // two cases for multi-bit flags:
 | 
			
		||||
            //
 | 
			
		||||
            // 1. When flags partially overlap, such as `0b00000001` and `0b00000101`, we'll
 | 
			
		||||
            // yield both flags.
 | 
			
		||||
            // 2. When flags fully overlap, such as in convenience flags that are a shorthand for others,
 | 
			
		||||
            // we won't yield both flags.
 | 
			
		||||
            if self.source.contains(B::from_bits_retain(bits))
 | 
			
		||||
                && self.remaining.intersects(B::from_bits_retain(bits))
 | 
			
		||||
            {
 | 
			
		||||
                self.remaining.remove(B::from_bits_retain(bits));
 | 
			
		||||
 | 
			
		||||
                return Some((flag.name(), B::from_bits_retain(bits)));
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        None
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										921
									
								
								vendor/bitflags/src/lib.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										921
									
								
								vendor/bitflags/src/lib.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,921 @@
 | 
			
		||||
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
 | 
			
		||||
// file at the top-level directory of this distribution and at
 | 
			
		||||
// http://rust-lang.org/COPYRIGHT.
 | 
			
		||||
//
 | 
			
		||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 | 
			
		||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 | 
			
		||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 | 
			
		||||
// option. This file may not be copied, modified, or distributed
 | 
			
		||||
// except according to those terms.
 | 
			
		||||
 | 
			
		||||
/*!
 | 
			
		||||
Generate types for C-style flags with ergonomic APIs.
 | 
			
		||||
 | 
			
		||||
# Getting started
 | 
			
		||||
 | 
			
		||||
Add `bitflags` to your `Cargo.toml`:
 | 
			
		||||
 | 
			
		||||
```toml
 | 
			
		||||
[dependencies.bitflags]
 | 
			
		||||
version = "2.4.1"
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Generating flags types
 | 
			
		||||
 | 
			
		||||
Use the [`bitflags`] macro to generate flags types:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
use bitflags::bitflags;
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    pub struct Flags: u32 {
 | 
			
		||||
        const A = 0b00000001;
 | 
			
		||||
        const B = 0b00000010;
 | 
			
		||||
        const C = 0b00000100;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
See the docs for the `bitflags` macro for the full syntax.
 | 
			
		||||
 | 
			
		||||
Also see the [`example_generated`] module for an example of what the `bitflags` macro generates for a flags type.
 | 
			
		||||
 | 
			
		||||
### Externally defined flags
 | 
			
		||||
 | 
			
		||||
If you're generating flags types for an external source, such as a C API, you can define
 | 
			
		||||
an extra unnamed flag as a mask of all bits the external source may ever set. Usually this would be all bits (`!0`):
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    pub struct Flags: u32 {
 | 
			
		||||
        const A = 0b00000001;
 | 
			
		||||
        const B = 0b00000010;
 | 
			
		||||
        const C = 0b00000100;
 | 
			
		||||
 | 
			
		||||
        // The source may set any bits
 | 
			
		||||
        const _ = !0;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Why should you do this? Generated methods like `all` and truncating operators like `!` only consider
 | 
			
		||||
bits in defined flags. Adding an unnamed flag makes those methods consider additional bits,
 | 
			
		||||
without generating additional constants for them. It helps compatibility when the external source
 | 
			
		||||
may start setting additional bits at any time. The [known and unknown bits](#known-and-unknown-bits)
 | 
			
		||||
section has more details on this behavior.
 | 
			
		||||
 | 
			
		||||
### Custom derives
 | 
			
		||||
 | 
			
		||||
You can derive some traits on generated flags types if you enable Cargo features. The following
 | 
			
		||||
libraries are currently supported:
 | 
			
		||||
 | 
			
		||||
- `serde`: Support `#[derive(Serialize, Deserialize)]`, using text for human-readable formats,
 | 
			
		||||
and a raw number for binary formats.
 | 
			
		||||
- `arbitrary`: Support `#[derive(Arbitrary)]`, only generating flags values with known bits.
 | 
			
		||||
- `bytemuck`: Support `#[derive(Pod, Zeroable)]`, for casting between flags values and their
 | 
			
		||||
underlying bits values.
 | 
			
		||||
 | 
			
		||||
You can also define your own flags type outside of the [`bitflags`] macro and then use it to generate methods.
 | 
			
		||||
This can be useful if you need a custom `#[derive]` attribute for a library that `bitflags` doesn't
 | 
			
		||||
natively support:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
# use std::fmt::Debug as SomeTrait;
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
#[derive(SomeTrait)]
 | 
			
		||||
pub struct Flags(u32);
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    impl Flags: u32 {
 | 
			
		||||
        const A = 0b00000001;
 | 
			
		||||
        const B = 0b00000010;
 | 
			
		||||
        const C = 0b00000100;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Adding custom methods
 | 
			
		||||
 | 
			
		||||
The [`bitflags`] macro supports attributes on generated flags types within the macro itself, while
 | 
			
		||||
`impl` blocks can be added outside of it:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    // Attributes can be applied to flags types
 | 
			
		||||
    #[repr(transparent)]
 | 
			
		||||
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 | 
			
		||||
    pub struct Flags: u32 {
 | 
			
		||||
        const A = 0b00000001;
 | 
			
		||||
        const B = 0b00000010;
 | 
			
		||||
        const C = 0b00000100;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Impl blocks can be added to flags types
 | 
			
		||||
impl Flags {
 | 
			
		||||
    pub fn as_u64(&self) -> u64 {
 | 
			
		||||
        self.bits() as u64
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Working with flags values
 | 
			
		||||
 | 
			
		||||
Use generated constants and standard bitwise operators to interact with flags values:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
# bitflags! {
 | 
			
		||||
#     #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 | 
			
		||||
#     pub struct Flags: u32 {
 | 
			
		||||
#         const A = 0b00000001;
 | 
			
		||||
#         const B = 0b00000010;
 | 
			
		||||
#         const C = 0b00000100;
 | 
			
		||||
#     }
 | 
			
		||||
# }
 | 
			
		||||
// union
 | 
			
		||||
let ab = Flags::A | Flags::B;
 | 
			
		||||
 | 
			
		||||
// intersection
 | 
			
		||||
let a = ab & Flags::A;
 | 
			
		||||
 | 
			
		||||
// difference
 | 
			
		||||
let b = ab - Flags::A;
 | 
			
		||||
 | 
			
		||||
// complement
 | 
			
		||||
let c = !ab;
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
See the docs for the [`Flags`] trait for more details on operators and how they behave.
 | 
			
		||||
 | 
			
		||||
# Formatting and parsing
 | 
			
		||||
 | 
			
		||||
`bitflags` defines a text format that can be used to convert any flags value to and from strings.
 | 
			
		||||
 | 
			
		||||
See the [`parser`] module for more details.
 | 
			
		||||
 | 
			
		||||
# Specification
 | 
			
		||||
 | 
			
		||||
The terminology and behavior of generated flags types is
 | 
			
		||||
[specified in the source repository](https://github.com/bitflags/bitflags/blob/main/spec.md).
 | 
			
		||||
Details are repeated in these docs where appropriate, but is exhaustively listed in the spec. Some
 | 
			
		||||
things are worth calling out explicitly here.
 | 
			
		||||
 | 
			
		||||
## Flags types, flags values, flags
 | 
			
		||||
 | 
			
		||||
The spec and these docs use consistent terminology to refer to things in the bitflags domain:
 | 
			
		||||
 | 
			
		||||
- **Bits type**: A type that defines a fixed number of bits at specific locations.
 | 
			
		||||
- **Flag**: A set of bits in a bits type that may have a unique name.
 | 
			
		||||
- **Flags type**: A set of defined flags over a specific bits type.
 | 
			
		||||
- **Flags value**: An instance of a flags type using its specific bits value for storage.
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct FlagsType: u8 {
 | 
			
		||||
//                    -- Bits type
 | 
			
		||||
//         --------- Flags type
 | 
			
		||||
        const A = 1;
 | 
			
		||||
//            ----- Flag
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
let flag = FlagsType::A;
 | 
			
		||||
//  ---- Flags value
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Known and unknown bits
 | 
			
		||||
 | 
			
		||||
Any bits in a flag you define are called _known bits_. Any other bits are _unknown bits_.
 | 
			
		||||
In the following flags type:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
        const C = 1 << 2;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
The known bits are `0b0000_0111` and the unknown bits are `0b1111_1000`.
 | 
			
		||||
 | 
			
		||||
`bitflags` doesn't guarantee that a flags value will only ever have known bits set, but some operators
 | 
			
		||||
will unset any unknown bits they encounter. In a future version of `bitflags`, all operators will
 | 
			
		||||
unset unknown bits.
 | 
			
		||||
 | 
			
		||||
If you're using `bitflags` for flags types defined externally, such as from C, you probably want all
 | 
			
		||||
bits to be considered known, in case that external source changes. You can do this using an unnamed
 | 
			
		||||
flag, as described in [externally defined flags](#externally-defined-flags).
 | 
			
		||||
 | 
			
		||||
## Zero-bit flags
 | 
			
		||||
 | 
			
		||||
Flags with no bits set should be avoided because they interact strangely with [`Flags::contains`]
 | 
			
		||||
and [`Flags::intersects`]. A zero-bit flag is always contained, but is never intersected. The
 | 
			
		||||
names of zero-bit flags can be parsed, but are never formatted.
 | 
			
		||||
 | 
			
		||||
## Multi-bit flags
 | 
			
		||||
 | 
			
		||||
Flags that set multiple bits should be avoided unless each bit is also in a single-bit flag.
 | 
			
		||||
Take the following flags type as an example:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 | 1 << 1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
The result of `Flags::A ^ Flags::B` is `0b0000_0010`, which doesn't correspond to either
 | 
			
		||||
`Flags::A` or `Flags::B` even though it's still a known bit.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#![cfg_attr(not(any(feature = "std", test)), no_std)]
 | 
			
		||||
#![cfg_attr(not(test), forbid(unsafe_code))]
 | 
			
		||||
#![cfg_attr(test, allow(mixed_script_confusables))]
 | 
			
		||||
 | 
			
		||||
#[doc(inline)]
 | 
			
		||||
pub use traits::{Bits, Flag, Flags};
 | 
			
		||||
 | 
			
		||||
pub mod iter;
 | 
			
		||||
pub mod parser;
 | 
			
		||||
 | 
			
		||||
mod traits;
 | 
			
		||||
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
pub mod __private {
 | 
			
		||||
    pub use crate::{external::__private::*, traits::__private::*};
 | 
			
		||||
 | 
			
		||||
    pub use core;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[allow(unused_imports)]
 | 
			
		||||
pub use external::*;
 | 
			
		||||
 | 
			
		||||
#[allow(deprecated)]
 | 
			
		||||
pub use traits::BitFlags;
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
How does the bitflags crate work?
 | 
			
		||||
 | 
			
		||||
This library generates a `struct` in the end-user's crate with a bunch of constants on it that represent flags.
 | 
			
		||||
The difference between `bitflags` and a lot of other libraries is that we don't actually control the generated `struct` in the end.
 | 
			
		||||
It's part of the end-user's crate, so it belongs to them. That makes it difficult to extend `bitflags` with new functionality
 | 
			
		||||
because we could end up breaking valid code that was already written.
 | 
			
		||||
 | 
			
		||||
Our solution is to split the type we generate into two: the public struct owned by the end-user, and an internal struct owned by `bitflags` (us).
 | 
			
		||||
To give you an example, let's say we had a crate that called `bitflags!`:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
bitflags! {
 | 
			
		||||
    pub struct MyFlags: u32 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 2;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
What they'd end up with looks something like this:
 | 
			
		||||
 | 
			
		||||
```rust
 | 
			
		||||
pub struct MyFlags(<MyFlags as PublicFlags>::InternalBitFlags);
 | 
			
		||||
 | 
			
		||||
const _: () = {
 | 
			
		||||
    #[repr(transparent)]
 | 
			
		||||
    #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
 | 
			
		||||
    pub struct MyInternalBitFlags {
 | 
			
		||||
        bits: u32,
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    impl PublicFlags for MyFlags {
 | 
			
		||||
        type Internal = InternalBitFlags;
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
If we want to expose something like a new trait impl for generated flags types, we add it to our generated `MyInternalBitFlags`,
 | 
			
		||||
and let `#[derive]` on `MyFlags` pick up that implementation, if an end-user chooses to add one.
 | 
			
		||||
 | 
			
		||||
The public API is generated in the `__impl_public_flags!` macro, and the internal API is generated in
 | 
			
		||||
the `__impl_internal_flags!` macro.
 | 
			
		||||
 | 
			
		||||
The macros are split into 3 modules:
 | 
			
		||||
 | 
			
		||||
- `public`: where the user-facing flags types are generated.
 | 
			
		||||
- `internal`: where the `bitflags`-facing flags types are generated.
 | 
			
		||||
- `external`: where external library traits are implemented conditionally.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Generate a flags type.
 | 
			
		||||
 | 
			
		||||
# `struct` mode
 | 
			
		||||
 | 
			
		||||
A declaration that begins with `$vis struct` will generate a `struct` for a flags type, along with
 | 
			
		||||
methods and trait implementations for it. The body of the declaration defines flags as constants,
 | 
			
		||||
where each constant is a flags value of the generated flags type.
 | 
			
		||||
 | 
			
		||||
## Examples
 | 
			
		||||
 | 
			
		||||
Generate a flags type using `u8` as the bits type:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
        const C = 0b0000_0100;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Flags types are private by default and accept standard visibility modifiers. Flags themselves
 | 
			
		||||
are always public:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    pub struct Flags: u8 {
 | 
			
		||||
        // Constants are always `pub`
 | 
			
		||||
        const A = 1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Flags may refer to other flags using their [`Flags::bits`] value:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
        const AB = Flags::A.bits() | Flags::B.bits();
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
A single `bitflags` invocation may include zero or more flags type declarations:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {}
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags1: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    struct Flags2: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
# `impl` mode
 | 
			
		||||
 | 
			
		||||
A declaration that begins with `impl` will only generate methods and trait implementations for the
 | 
			
		||||
`struct` defined outside of the `bitflags` macro.
 | 
			
		||||
 | 
			
		||||
The struct itself must be a newtype using the bits type as its field.
 | 
			
		||||
 | 
			
		||||
The syntax for `impl` mode is identical to `struct` mode besides the starting token.
 | 
			
		||||
 | 
			
		||||
## Examples
 | 
			
		||||
 | 
			
		||||
Implement flags methods and traits for a custom flags type using `u8` as its underlying bits type:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
struct Flags(u8);
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    impl Flags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
        const C = 0b0000_0100;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
# Named and unnamed flags
 | 
			
		||||
 | 
			
		||||
Constants in the body of a declaration are flags. The identifier of the constant is the name of
 | 
			
		||||
the flag. If the identifier is `_`, then the flag is unnamed. Unnamed flags don't appear in the
 | 
			
		||||
generated API, but affect how bits are truncated.
 | 
			
		||||
 | 
			
		||||
## Examples
 | 
			
		||||
 | 
			
		||||
Adding an unnamed flag that makes all bits known:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
 | 
			
		||||
        const _ = !0;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Flags types may define multiple unnamed flags:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::bitflags;
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct Flags: u8 {
 | 
			
		||||
        const _ = 1;
 | 
			
		||||
        const _ = 1 << 1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
*/
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
macro_rules! bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $(#[$outer:meta])*
 | 
			
		||||
        $vis:vis struct $BitFlags:ident: $T:ty {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt = $value:expr;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        $($t:tt)*
 | 
			
		||||
    ) => {
 | 
			
		||||
        // Declared in the scope of the `bitflags!` call
 | 
			
		||||
        // This type appears in the end-user's API
 | 
			
		||||
        __declare_public_bitflags! {
 | 
			
		||||
            $(#[$outer])*
 | 
			
		||||
            $vis struct $BitFlags
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Workaround for: https://github.com/bitflags/bitflags/issues/320
 | 
			
		||||
        __impl_public_bitflags_consts! {
 | 
			
		||||
            $BitFlags: $T {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner $($args)*])*
 | 
			
		||||
                    const $Flag = $value;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        #[allow(
 | 
			
		||||
            dead_code,
 | 
			
		||||
            deprecated,
 | 
			
		||||
            unused_doc_comments,
 | 
			
		||||
            unused_attributes,
 | 
			
		||||
            unused_mut,
 | 
			
		||||
            unused_imports,
 | 
			
		||||
            non_upper_case_globals,
 | 
			
		||||
            clippy::assign_op_pattern,
 | 
			
		||||
            clippy::indexing_slicing,
 | 
			
		||||
            clippy::same_name_method,
 | 
			
		||||
            clippy::iter_without_into_iter,
 | 
			
		||||
        )]
 | 
			
		||||
        const _: () = {
 | 
			
		||||
            // Declared in a "hidden" scope that can't be reached directly
 | 
			
		||||
            // These types don't appear in the end-user's API
 | 
			
		||||
            __declare_internal_bitflags! {
 | 
			
		||||
                $vis struct InternalBitFlags: $T
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            __impl_internal_bitflags! {
 | 
			
		||||
                InternalBitFlags: $T, $BitFlags {
 | 
			
		||||
                    $(
 | 
			
		||||
                        $(#[$inner $($args)*])*
 | 
			
		||||
                        const $Flag = $value;
 | 
			
		||||
                    )*
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // This is where new library trait implementations can be added
 | 
			
		||||
            __impl_external_bitflags! {
 | 
			
		||||
                InternalBitFlags: $T, $BitFlags {
 | 
			
		||||
                    $(
 | 
			
		||||
                        $(#[$inner $($args)*])*
 | 
			
		||||
                        const $Flag;
 | 
			
		||||
                    )*
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            __impl_public_bitflags_forward! {
 | 
			
		||||
                $BitFlags: $T, InternalBitFlags
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            __impl_public_bitflags_ops! {
 | 
			
		||||
                $BitFlags
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            __impl_public_bitflags_iter! {
 | 
			
		||||
                $BitFlags: $T, $BitFlags
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        bitflags! {
 | 
			
		||||
            $($t)*
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
    (
 | 
			
		||||
        impl $BitFlags:ident: $T:ty {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt = $value:expr;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        $($t:tt)*
 | 
			
		||||
    ) => {
 | 
			
		||||
        __impl_public_bitflags_consts! {
 | 
			
		||||
            $BitFlags: $T {
 | 
			
		||||
                $(
 | 
			
		||||
                    $(#[$inner $($args)*])*
 | 
			
		||||
                    const $Flag = $value;
 | 
			
		||||
                )*
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        #[allow(
 | 
			
		||||
            dead_code,
 | 
			
		||||
            deprecated,
 | 
			
		||||
            unused_doc_comments,
 | 
			
		||||
            unused_attributes,
 | 
			
		||||
            unused_mut,
 | 
			
		||||
            unused_imports,
 | 
			
		||||
            non_upper_case_globals,
 | 
			
		||||
            clippy::assign_op_pattern,
 | 
			
		||||
            clippy::iter_without_into_iter,
 | 
			
		||||
        )]
 | 
			
		||||
        const _: () = {
 | 
			
		||||
            __impl_public_bitflags! {
 | 
			
		||||
                $BitFlags: $T, $BitFlags {
 | 
			
		||||
                    $(
 | 
			
		||||
                        $(#[$inner $($args)*])*
 | 
			
		||||
                        const $Flag = $value;
 | 
			
		||||
                    )*
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            __impl_public_bitflags_ops! {
 | 
			
		||||
                $BitFlags
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            __impl_public_bitflags_iter! {
 | 
			
		||||
                $BitFlags: $T, $BitFlags
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        bitflags! {
 | 
			
		||||
            $($t)*
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
    () => {};
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement functions on bitflags types.
 | 
			
		||||
///
 | 
			
		||||
/// We need to be careful about adding new methods and trait implementations here because they
 | 
			
		||||
/// could conflict with items added by the end-user.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $PublicBitFlags:ident: $T:ty {
 | 
			
		||||
            fn empty() $empty:block
 | 
			
		||||
            fn all() $all:block
 | 
			
		||||
            fn bits($bits0:ident) $bits:block
 | 
			
		||||
            fn from_bits($from_bits0:ident) $from_bits:block
 | 
			
		||||
            fn from_bits_truncate($from_bits_truncate0:ident) $from_bits_truncate:block
 | 
			
		||||
            fn from_bits_retain($from_bits_retain0:ident) $from_bits_retain:block
 | 
			
		||||
            fn from_name($from_name0:ident) $from_name:block
 | 
			
		||||
            fn is_empty($is_empty0:ident) $is_empty:block
 | 
			
		||||
            fn is_all($is_all0:ident) $is_all:block
 | 
			
		||||
            fn intersects($intersects0:ident, $intersects1:ident) $intersects:block
 | 
			
		||||
            fn contains($contains0:ident, $contains1:ident) $contains:block
 | 
			
		||||
            fn insert($insert0:ident, $insert1:ident) $insert:block
 | 
			
		||||
            fn remove($remove0:ident, $remove1:ident) $remove:block
 | 
			
		||||
            fn toggle($toggle0:ident, $toggle1:ident) $toggle:block
 | 
			
		||||
            fn set($set0:ident, $set1:ident, $set2:ident) $set:block
 | 
			
		||||
            fn intersection($intersection0:ident, $intersection1:ident) $intersection:block
 | 
			
		||||
            fn union($union0:ident, $union1:ident) $union:block
 | 
			
		||||
            fn difference($difference0:ident, $difference1:ident) $difference:block
 | 
			
		||||
            fn symmetric_difference($symmetric_difference0:ident, $symmetric_difference1:ident) $symmetric_difference:block
 | 
			
		||||
            fn complement($complement0:ident) $complement:block
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        #[allow(dead_code, deprecated, unused_attributes)]
 | 
			
		||||
        impl $PublicBitFlags {
 | 
			
		||||
            /// Get a flags value with all bits unset.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn empty() -> Self {
 | 
			
		||||
                $empty
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Get a flags value with all known bits set.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn all() -> Self {
 | 
			
		||||
                $all
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Get the underlying bits value.
 | 
			
		||||
            ///
 | 
			
		||||
            /// The returned value is exactly the bits set in this flags value.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn bits(&self) -> $T {
 | 
			
		||||
                let $bits0 = self;
 | 
			
		||||
                $bits
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Convert from a bits value.
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method will return `None` if any unknown bits are set.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn from_bits(bits: $T) -> $crate::__private::core::option::Option<Self> {
 | 
			
		||||
                let $from_bits0 = bits;
 | 
			
		||||
                $from_bits
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Convert from a bits value, unsetting any unknown bits.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn from_bits_truncate(bits: $T) -> Self {
 | 
			
		||||
                let $from_bits_truncate0 = bits;
 | 
			
		||||
                $from_bits_truncate
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Convert from a bits value exactly.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn from_bits_retain(bits: $T) -> Self {
 | 
			
		||||
                let $from_bits_retain0 = bits;
 | 
			
		||||
                $from_bits_retain
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Get a flags value with the bits of a flag with the given name set.
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method will return `None` if `name` is empty or doesn't
 | 
			
		||||
            /// correspond to any named flag.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub fn from_name(name: &str) -> $crate::__private::core::option::Option<Self> {
 | 
			
		||||
                let $from_name0 = name;
 | 
			
		||||
                $from_name
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Whether all bits in this flags value are unset.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn is_empty(&self) -> bool {
 | 
			
		||||
                let $is_empty0 = self;
 | 
			
		||||
                $is_empty
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Whether all known bits in this flags value are set.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn is_all(&self) -> bool {
 | 
			
		||||
                let $is_all0 = self;
 | 
			
		||||
                $is_all
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Whether any set bits in a source flags value are also set in a target flags value.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn intersects(&self, other: Self) -> bool {
 | 
			
		||||
                let $intersects0 = self;
 | 
			
		||||
                let $intersects1 = other;
 | 
			
		||||
                $intersects
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Whether all set bits in a source flags value are also set in a target flags value.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn contains(&self, other: Self) -> bool {
 | 
			
		||||
                let $contains0 = self;
 | 
			
		||||
                let $contains1 = other;
 | 
			
		||||
                $contains
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The bitwise or (`|`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub fn insert(&mut self, other: Self) {
 | 
			
		||||
                let $insert0 = self;
 | 
			
		||||
                let $insert1 = other;
 | 
			
		||||
                $insert
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The intersection of a source flags value with the complement of a target flags value (`&!`).
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method is not equivalent to `self & !other` when `other` has unknown bits set.
 | 
			
		||||
            /// `remove` won't truncate `other`, but the `!` operator will.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub fn remove(&mut self, other: Self) {
 | 
			
		||||
                let $remove0 = self;
 | 
			
		||||
                let $remove1 = other;
 | 
			
		||||
                $remove
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The bitwise exclusive-or (`^`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub fn toggle(&mut self, other: Self) {
 | 
			
		||||
                let $toggle0 = self;
 | 
			
		||||
                let $toggle1 = other;
 | 
			
		||||
                $toggle
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Call `insert` when `value` is `true` or `remove` when `value` is `false`.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub fn set(&mut self, other: Self, value: bool) {
 | 
			
		||||
                let $set0 = self;
 | 
			
		||||
                let $set1 = other;
 | 
			
		||||
                let $set2 = value;
 | 
			
		||||
                $set
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The bitwise and (`&`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            #[must_use]
 | 
			
		||||
            pub const fn intersection(self, other: Self) -> Self {
 | 
			
		||||
                let $intersection0 = self;
 | 
			
		||||
                let $intersection1 = other;
 | 
			
		||||
                $intersection
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The bitwise or (`|`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            #[must_use]
 | 
			
		||||
            pub const fn union(self, other: Self) -> Self {
 | 
			
		||||
                let $union0 = self;
 | 
			
		||||
                let $union1 = other;
 | 
			
		||||
                $union
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The intersection of a source flags value with the complement of a target flags value (`&!`).
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method is not equivalent to `self & !other` when `other` has unknown bits set.
 | 
			
		||||
            /// `difference` won't truncate `other`, but the `!` operator will.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            #[must_use]
 | 
			
		||||
            pub const fn difference(self, other: Self) -> Self {
 | 
			
		||||
                let $difference0 = self;
 | 
			
		||||
                let $difference1 = other;
 | 
			
		||||
                $difference
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The bitwise exclusive-or (`^`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            #[must_use]
 | 
			
		||||
            pub const fn symmetric_difference(self, other: Self) -> Self {
 | 
			
		||||
                let $symmetric_difference0 = self;
 | 
			
		||||
                let $symmetric_difference1 = other;
 | 
			
		||||
                $symmetric_difference
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            #[must_use]
 | 
			
		||||
            pub const fn complement(self) -> Self {
 | 
			
		||||
                let $complement0 = self;
 | 
			
		||||
                $complement
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// A macro that processed the input to `bitflags!` and shuffles attributes around
 | 
			
		||||
/// based on whether or not they're "expression-safe".
 | 
			
		||||
///
 | 
			
		||||
/// This macro is a token-tree muncher that works on 2 levels:
 | 
			
		||||
///
 | 
			
		||||
/// For each attribute, we explicitly match on its identifier, like `cfg` to determine
 | 
			
		||||
/// whether or not it should be considered expression-safe.
 | 
			
		||||
///
 | 
			
		||||
/// If you find yourself with an attribute that should be considered expression-safe
 | 
			
		||||
/// and isn't, it can be added here.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __bitflags_expr_safe_attrs {
 | 
			
		||||
    // Entrypoint: Move all flags and all attributes into `unprocessed` lists
 | 
			
		||||
    // where they'll be munched one-at-a-time
 | 
			
		||||
    (
 | 
			
		||||
        $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
        { $e:expr }
 | 
			
		||||
    ) => {
 | 
			
		||||
        __bitflags_expr_safe_attrs! {
 | 
			
		||||
            expr: { $e },
 | 
			
		||||
            attrs: {
 | 
			
		||||
                // All attributes start here
 | 
			
		||||
                unprocessed: [$(#[$inner $($args)*])*],
 | 
			
		||||
                // Attributes that are safe on expressions go here
 | 
			
		||||
                processed: [],
 | 
			
		||||
            },
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
    // Process the next attribute on the current flag
 | 
			
		||||
    // `cfg`: The next flag should be propagated to expressions
 | 
			
		||||
    // NOTE: You can copy this rules block and replace `cfg` with
 | 
			
		||||
    // your attribute name that should be considered expression-safe
 | 
			
		||||
    (
 | 
			
		||||
        expr: { $e:expr },
 | 
			
		||||
            attrs: {
 | 
			
		||||
            unprocessed: [
 | 
			
		||||
                // cfg matched here
 | 
			
		||||
                #[cfg $($args:tt)*]
 | 
			
		||||
                $($attrs_rest:tt)*
 | 
			
		||||
            ],
 | 
			
		||||
            processed: [$($expr:tt)*],
 | 
			
		||||
        },
 | 
			
		||||
    ) => {
 | 
			
		||||
        __bitflags_expr_safe_attrs! {
 | 
			
		||||
            expr: { $e },
 | 
			
		||||
            attrs: {
 | 
			
		||||
                unprocessed: [
 | 
			
		||||
                    $($attrs_rest)*
 | 
			
		||||
                ],
 | 
			
		||||
                processed: [
 | 
			
		||||
                    $($expr)*
 | 
			
		||||
                    // cfg added here
 | 
			
		||||
                    #[cfg $($args)*]
 | 
			
		||||
                ],
 | 
			
		||||
            },
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
    // Process the next attribute on the current flag
 | 
			
		||||
    // `$other`: The next flag should not be propagated to expressions
 | 
			
		||||
    (
 | 
			
		||||
        expr: { $e:expr },
 | 
			
		||||
            attrs: {
 | 
			
		||||
            unprocessed: [
 | 
			
		||||
                // $other matched here
 | 
			
		||||
                #[$other:ident $($args:tt)*]
 | 
			
		||||
                $($attrs_rest:tt)*
 | 
			
		||||
            ],
 | 
			
		||||
            processed: [$($expr:tt)*],
 | 
			
		||||
        },
 | 
			
		||||
    ) => {
 | 
			
		||||
        __bitflags_expr_safe_attrs! {
 | 
			
		||||
            expr: { $e },
 | 
			
		||||
                attrs: {
 | 
			
		||||
                unprocessed: [
 | 
			
		||||
                    $($attrs_rest)*
 | 
			
		||||
                ],
 | 
			
		||||
                processed: [
 | 
			
		||||
                    // $other not added here
 | 
			
		||||
                    $($expr)*
 | 
			
		||||
                ],
 | 
			
		||||
            },
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
    // Once all attributes on all flags are processed, generate the actual code
 | 
			
		||||
    (
 | 
			
		||||
        expr: { $e:expr },
 | 
			
		||||
        attrs: {
 | 
			
		||||
            unprocessed: [],
 | 
			
		||||
            processed: [$(#[$expr:ident $($exprargs:tt)*])*],
 | 
			
		||||
        },
 | 
			
		||||
    ) => {
 | 
			
		||||
        $(#[$expr $($exprargs)*])*
 | 
			
		||||
        { $e }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement a flag, which may be a wildcard `_`.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __bitflags_flag {
 | 
			
		||||
    (
 | 
			
		||||
        {
 | 
			
		||||
            name: _,
 | 
			
		||||
            named: { $($named:tt)* },
 | 
			
		||||
            unnamed: { $($unnamed:tt)* },
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        $($unnamed)*
 | 
			
		||||
    };
 | 
			
		||||
    (
 | 
			
		||||
        {
 | 
			
		||||
            name: $Flag:ident,
 | 
			
		||||
            named: { $($named:tt)* },
 | 
			
		||||
            unnamed: { $($unnamed:tt)* },
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        $($named)*
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[macro_use]
 | 
			
		||||
mod public;
 | 
			
		||||
#[macro_use]
 | 
			
		||||
mod internal;
 | 
			
		||||
#[macro_use]
 | 
			
		||||
mod external;
 | 
			
		||||
 | 
			
		||||
#[cfg(feature = "example_generated")]
 | 
			
		||||
pub mod example_generated;
 | 
			
		||||
 | 
			
		||||
#[cfg(test)]
 | 
			
		||||
mod tests;
 | 
			
		||||
							
								
								
									
										247
									
								
								vendor/bitflags/src/parser.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										247
									
								
								vendor/bitflags/src/parser.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,247 @@
 | 
			
		||||
/*!
 | 
			
		||||
Parsing flags from text.
 | 
			
		||||
 | 
			
		||||
Format and parse a flags value as text using the following grammar:
 | 
			
		||||
 | 
			
		||||
- _Flags:_ (_Whitespace_ _Flag_ _Whitespace_)`|`*
 | 
			
		||||
- _Flag:_ _Name_ | _Hex Number_
 | 
			
		||||
- _Name:_ The name of any defined flag
 | 
			
		||||
- _Hex Number_: `0x`([0-9a-fA-F])*
 | 
			
		||||
- _Whitespace_: (\s)*
 | 
			
		||||
 | 
			
		||||
As an example, this is how `Flags::A | Flags::B | 0x0c` can be represented as text:
 | 
			
		||||
 | 
			
		||||
```text
 | 
			
		||||
A | B | 0x0c
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Alternatively, it could be represented without whitespace:
 | 
			
		||||
 | 
			
		||||
```text
 | 
			
		||||
A|B|0x0C
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Note that identifiers are *case-sensitive*, so the following is *not equivalent*:
 | 
			
		||||
 | 
			
		||||
```text
 | 
			
		||||
a|b|0x0C
 | 
			
		||||
```
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#![allow(clippy::let_unit_value)]
 | 
			
		||||
 | 
			
		||||
use core::fmt::{self, Write};
 | 
			
		||||
 | 
			
		||||
use crate::{Bits, Flags};
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Write a flags value as text.
 | 
			
		||||
 | 
			
		||||
Any bits that aren't part of a contained flag will be formatted as a hex number.
 | 
			
		||||
*/
 | 
			
		||||
pub fn to_writer<B: Flags>(flags: &B, mut writer: impl Write) -> Result<(), fmt::Error>
 | 
			
		||||
where
 | 
			
		||||
    B::Bits: WriteHex,
 | 
			
		||||
{
 | 
			
		||||
    // A formatter for bitflags that produces text output like:
 | 
			
		||||
    //
 | 
			
		||||
    // A | B | 0xf6
 | 
			
		||||
    //
 | 
			
		||||
    // The names of set flags are written in a bar-separated-format,
 | 
			
		||||
    // followed by a hex number of any remaining bits that are set
 | 
			
		||||
    // but don't correspond to any flags.
 | 
			
		||||
 | 
			
		||||
    // Iterate over known flag values
 | 
			
		||||
    let mut first = true;
 | 
			
		||||
    let mut iter = flags.iter_names();
 | 
			
		||||
    for (name, _) in &mut iter {
 | 
			
		||||
        if !first {
 | 
			
		||||
            writer.write_str(" | ")?;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        first = false;
 | 
			
		||||
        writer.write_str(name)?;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Append any extra bits that correspond to flags to the end of the format
 | 
			
		||||
    let remaining = iter.remaining().bits();
 | 
			
		||||
    if remaining != B::Bits::EMPTY {
 | 
			
		||||
        if !first {
 | 
			
		||||
            writer.write_str(" | ")?;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        writer.write_str("0x")?;
 | 
			
		||||
        remaining.write_hex(writer)?;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fmt::Result::Ok(())
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
pub(crate) struct AsDisplay<'a, B>(pub(crate) &'a B);
 | 
			
		||||
 | 
			
		||||
impl<'a, B: Flags> fmt::Display for AsDisplay<'a, B>
 | 
			
		||||
where
 | 
			
		||||
    B::Bits: WriteHex,
 | 
			
		||||
{
 | 
			
		||||
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 | 
			
		||||
        to_writer(self.0, f)
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Parse a flags value from text.
 | 
			
		||||
 | 
			
		||||
This function will fail on any names that don't correspond to defined flags.
 | 
			
		||||
Unknown bits will be retained.
 | 
			
		||||
*/
 | 
			
		||||
pub fn from_str<B: Flags>(input: &str) -> Result<B, ParseError>
 | 
			
		||||
where
 | 
			
		||||
    B::Bits: ParseHex,
 | 
			
		||||
{
 | 
			
		||||
    let mut parsed_flags = B::empty();
 | 
			
		||||
 | 
			
		||||
    // If the input is empty then return an empty set of flags
 | 
			
		||||
    if input.trim().is_empty() {
 | 
			
		||||
        return Ok(parsed_flags);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    for flag in input.split('|') {
 | 
			
		||||
        let flag = flag.trim();
 | 
			
		||||
 | 
			
		||||
        // If the flag is empty then we've got missing input
 | 
			
		||||
        if flag.is_empty() {
 | 
			
		||||
            return Err(ParseError::empty_flag());
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // If the flag starts with `0x` then it's a hex number
 | 
			
		||||
        // Parse it directly to the underlying bits type
 | 
			
		||||
        let parsed_flag = if let Some(flag) = flag.strip_prefix("0x") {
 | 
			
		||||
            let bits =
 | 
			
		||||
                <B::Bits>::parse_hex(flag).map_err(|_| ParseError::invalid_hex_flag(flag))?;
 | 
			
		||||
 | 
			
		||||
            B::from_bits_retain(bits)
 | 
			
		||||
        }
 | 
			
		||||
        // Otherwise the flag is a name
 | 
			
		||||
        // The generated flags type will determine whether
 | 
			
		||||
        // or not it's a valid identifier
 | 
			
		||||
        else {
 | 
			
		||||
            B::from_name(flag).ok_or_else(|| ParseError::invalid_named_flag(flag))?
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        parsed_flags.insert(parsed_flag);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    Ok(parsed_flags)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Encode a value as a hex string.
 | 
			
		||||
 | 
			
		||||
Implementors of this trait should not write the `0x` prefix.
 | 
			
		||||
*/
 | 
			
		||||
pub trait WriteHex {
 | 
			
		||||
    /// Write the value as hex.
 | 
			
		||||
    fn write_hex<W: fmt::Write>(&self, writer: W) -> fmt::Result;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
Parse a value from a hex string.
 | 
			
		||||
*/
 | 
			
		||||
pub trait ParseHex {
 | 
			
		||||
    /// Parse the value from hex.
 | 
			
		||||
    fn parse_hex(input: &str) -> Result<Self, ParseError>
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// An error encountered while parsing flags from text.
 | 
			
		||||
#[derive(Debug)]
 | 
			
		||||
pub struct ParseError(ParseErrorKind);
 | 
			
		||||
 | 
			
		||||
#[derive(Debug)]
 | 
			
		||||
#[allow(clippy::enum_variant_names)]
 | 
			
		||||
enum ParseErrorKind {
 | 
			
		||||
    EmptyFlag,
 | 
			
		||||
    InvalidNamedFlag {
 | 
			
		||||
        #[cfg(not(feature = "std"))]
 | 
			
		||||
        got: (),
 | 
			
		||||
        #[cfg(feature = "std")]
 | 
			
		||||
        got: String,
 | 
			
		||||
    },
 | 
			
		||||
    InvalidHexFlag {
 | 
			
		||||
        #[cfg(not(feature = "std"))]
 | 
			
		||||
        got: (),
 | 
			
		||||
        #[cfg(feature = "std")]
 | 
			
		||||
        got: String,
 | 
			
		||||
    },
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl ParseError {
 | 
			
		||||
    /// An invalid hex flag was encountered.
 | 
			
		||||
    pub fn invalid_hex_flag(flag: impl fmt::Display) -> Self {
 | 
			
		||||
        let _flag = flag;
 | 
			
		||||
 | 
			
		||||
        let got = {
 | 
			
		||||
            #[cfg(feature = "std")]
 | 
			
		||||
            {
 | 
			
		||||
                _flag.to_string()
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        ParseError(ParseErrorKind::InvalidHexFlag { got })
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// A named flag that doesn't correspond to any on the flags type was encountered.
 | 
			
		||||
    pub fn invalid_named_flag(flag: impl fmt::Display) -> Self {
 | 
			
		||||
        let _flag = flag;
 | 
			
		||||
 | 
			
		||||
        let got = {
 | 
			
		||||
            #[cfg(feature = "std")]
 | 
			
		||||
            {
 | 
			
		||||
                _flag.to_string()
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        ParseError(ParseErrorKind::InvalidNamedFlag { got })
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// A hex or named flag wasn't found between separators.
 | 
			
		||||
    pub const fn empty_flag() -> Self {
 | 
			
		||||
        ParseError(ParseErrorKind::EmptyFlag)
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl fmt::Display for ParseError {
 | 
			
		||||
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 | 
			
		||||
        match &self.0 {
 | 
			
		||||
            ParseErrorKind::InvalidNamedFlag { got } => {
 | 
			
		||||
                let _got = got;
 | 
			
		||||
 | 
			
		||||
                write!(f, "unrecognized named flag")?;
 | 
			
		||||
 | 
			
		||||
                #[cfg(feature = "std")]
 | 
			
		||||
                {
 | 
			
		||||
                    write!(f, " `{}`", _got)?;
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
            ParseErrorKind::InvalidHexFlag { got } => {
 | 
			
		||||
                let _got = got;
 | 
			
		||||
 | 
			
		||||
                write!(f, "invalid hex flag")?;
 | 
			
		||||
 | 
			
		||||
                #[cfg(feature = "std")]
 | 
			
		||||
                {
 | 
			
		||||
                    write!(f, " `{}`", _got)?;
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
            ParseErrorKind::EmptyFlag => {
 | 
			
		||||
                write!(f, "encountered empty flag")?;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        Ok(())
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[cfg(feature = "std")]
 | 
			
		||||
impl std::error::Error for ParseError {}
 | 
			
		||||
							
								
								
									
										543
									
								
								vendor/bitflags/src/public.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										543
									
								
								vendor/bitflags/src/public.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,543 @@
 | 
			
		||||
//! Generate the user-facing flags type.
 | 
			
		||||
//!
 | 
			
		||||
//! The code here belongs to the end-user, so new trait implementations and methods can't be
 | 
			
		||||
//! added without potentially breaking users.
 | 
			
		||||
 | 
			
		||||
/// Declare the user-facing bitflags struct.
 | 
			
		||||
///
 | 
			
		||||
/// This type is guaranteed to be a newtype with a `bitflags`-facing type as its single field.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __declare_public_bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $(#[$outer:meta])*
 | 
			
		||||
        $vis:vis struct $PublicBitFlags:ident
 | 
			
		||||
    ) => {
 | 
			
		||||
        $(#[$outer])*
 | 
			
		||||
        $vis struct $PublicBitFlags(<$PublicBitFlags as $crate::__private::PublicFlags>::Internal);
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement functions on the public (user-facing) bitflags type.
 | 
			
		||||
///
 | 
			
		||||
/// We need to be careful about adding new methods and trait implementations here because they
 | 
			
		||||
/// could conflict with items added by the end-user.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_public_bitflags_forward {
 | 
			
		||||
    (
 | 
			
		||||
        $PublicBitFlags:ident: $T:ty, $InternalBitFlags:ident
 | 
			
		||||
    ) => {
 | 
			
		||||
        __impl_bitflags! {
 | 
			
		||||
            $PublicBitFlags: $T {
 | 
			
		||||
                fn empty() {
 | 
			
		||||
                    Self($InternalBitFlags::empty())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn all() {
 | 
			
		||||
                    Self($InternalBitFlags::all())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn bits(f) {
 | 
			
		||||
                    f.0.bits()
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_bits(bits) {
 | 
			
		||||
                    match $InternalBitFlags::from_bits(bits) {
 | 
			
		||||
                        $crate::__private::core::option::Option::Some(bits) => $crate::__private::core::option::Option::Some(Self(bits)),
 | 
			
		||||
                        $crate::__private::core::option::Option::None => $crate::__private::core::option::Option::None,
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_bits_truncate(bits) {
 | 
			
		||||
                    Self($InternalBitFlags::from_bits_truncate(bits))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_bits_retain(bits) {
 | 
			
		||||
                    Self($InternalBitFlags::from_bits_retain(bits))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_name(name) {
 | 
			
		||||
                    match $InternalBitFlags::from_name(name) {
 | 
			
		||||
                        $crate::__private::core::option::Option::Some(bits) => $crate::__private::core::option::Option::Some(Self(bits)),
 | 
			
		||||
                        $crate::__private::core::option::Option::None => $crate::__private::core::option::Option::None,
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn is_empty(f) {
 | 
			
		||||
                    f.0.is_empty()
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn is_all(f) {
 | 
			
		||||
                    f.0.is_all()
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn intersects(f, other) {
 | 
			
		||||
                    f.0.intersects(other.0)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn contains(f, other) {
 | 
			
		||||
                    f.0.contains(other.0)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn insert(f, other) {
 | 
			
		||||
                    f.0.insert(other.0)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn remove(f, other) {
 | 
			
		||||
                    f.0.remove(other.0)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn toggle(f, other) {
 | 
			
		||||
                    f.0.toggle(other.0)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn set(f, other, value) {
 | 
			
		||||
                    f.0.set(other.0, value)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn intersection(f, other) {
 | 
			
		||||
                    Self(f.0.intersection(other.0))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn union(f, other) {
 | 
			
		||||
                    Self(f.0.union(other.0))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn difference(f, other) {
 | 
			
		||||
                    Self(f.0.difference(other.0))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn symmetric_difference(f, other) {
 | 
			
		||||
                    Self(f.0.symmetric_difference(other.0))
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn complement(f) {
 | 
			
		||||
                    Self(f.0.complement())
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement functions on the public (user-facing) bitflags type.
 | 
			
		||||
///
 | 
			
		||||
/// We need to be careful about adding new methods and trait implementations here because they
 | 
			
		||||
/// could conflict with items added by the end-user.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_public_bitflags {
 | 
			
		||||
    (
 | 
			
		||||
        $BitFlags:ident: $T:ty, $PublicBitFlags:ident {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt = $value:expr;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        __impl_bitflags! {
 | 
			
		||||
            $BitFlags: $T {
 | 
			
		||||
                fn empty() {
 | 
			
		||||
                    Self(<$T as $crate::Bits>::EMPTY)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn all() {
 | 
			
		||||
                    let mut truncated = <$T as $crate::Bits>::EMPTY;
 | 
			
		||||
                    let mut i = 0;
 | 
			
		||||
 | 
			
		||||
                    $(
 | 
			
		||||
                        __bitflags_expr_safe_attrs!(
 | 
			
		||||
                            $(#[$inner $($args)*])*
 | 
			
		||||
                            {{
 | 
			
		||||
                                let flag = <$PublicBitFlags as $crate::Flags>::FLAGS[i].value().bits();
 | 
			
		||||
 | 
			
		||||
                                truncated = truncated | flag;
 | 
			
		||||
                                i += 1;
 | 
			
		||||
                            }}
 | 
			
		||||
                        );
 | 
			
		||||
                    )*
 | 
			
		||||
 | 
			
		||||
                    let _ = i;
 | 
			
		||||
                    Self::from_bits_retain(truncated)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn bits(f) {
 | 
			
		||||
                    f.0
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_bits(bits) {
 | 
			
		||||
                    let truncated = Self::from_bits_truncate(bits).0;
 | 
			
		||||
 | 
			
		||||
                    if truncated == bits {
 | 
			
		||||
                        $crate::__private::core::option::Option::Some(Self(bits))
 | 
			
		||||
                    } else {
 | 
			
		||||
                        $crate::__private::core::option::Option::None
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_bits_truncate(bits) {
 | 
			
		||||
                    Self(bits & Self::all().bits())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_bits_retain(bits) {
 | 
			
		||||
                    Self(bits)
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn from_name(name) {
 | 
			
		||||
                    $(
 | 
			
		||||
                        __bitflags_flag!({
 | 
			
		||||
                            name: $Flag,
 | 
			
		||||
                            named: {
 | 
			
		||||
                                __bitflags_expr_safe_attrs!(
 | 
			
		||||
                                    $(#[$inner $($args)*])*
 | 
			
		||||
                                    {
 | 
			
		||||
                                        if name == $crate::__private::core::stringify!($Flag) {
 | 
			
		||||
                                            return $crate::__private::core::option::Option::Some(Self($PublicBitFlags::$Flag.bits()));
 | 
			
		||||
                                        }
 | 
			
		||||
                                    }
 | 
			
		||||
                                );
 | 
			
		||||
                            },
 | 
			
		||||
                            unnamed: {},
 | 
			
		||||
                        });
 | 
			
		||||
                    )*
 | 
			
		||||
 | 
			
		||||
                    let _ = name;
 | 
			
		||||
                    $crate::__private::core::option::Option::None
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn is_empty(f) {
 | 
			
		||||
                    f.bits() == <$T as $crate::Bits>::EMPTY
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn is_all(f) {
 | 
			
		||||
                    // NOTE: We check against `Self::all` here, not `Self::Bits::ALL`
 | 
			
		||||
                    // because the set of all flags may not use all bits
 | 
			
		||||
                    Self::all().bits() | f.bits() == f.bits()
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn intersects(f, other) {
 | 
			
		||||
                    f.bits() & other.bits() != <$T as $crate::Bits>::EMPTY
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn contains(f, other) {
 | 
			
		||||
                    f.bits() & other.bits() == other.bits()
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn insert(f, other) {
 | 
			
		||||
                    *f = Self::from_bits_retain(f.bits()).union(other);
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn remove(f, other) {
 | 
			
		||||
                    *f = Self::from_bits_retain(f.bits()).difference(other);
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn toggle(f, other) {
 | 
			
		||||
                    *f = Self::from_bits_retain(f.bits()).symmetric_difference(other);
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn set(f, other, value) {
 | 
			
		||||
                    if value {
 | 
			
		||||
                        f.insert(other);
 | 
			
		||||
                    } else {
 | 
			
		||||
                        f.remove(other);
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn intersection(f, other) {
 | 
			
		||||
                    Self::from_bits_retain(f.bits() & other.bits())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn union(f, other) {
 | 
			
		||||
                    Self::from_bits_retain(f.bits() | other.bits())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn difference(f, other) {
 | 
			
		||||
                    Self::from_bits_retain(f.bits() & !other.bits())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn symmetric_difference(f, other) {
 | 
			
		||||
                    Self::from_bits_retain(f.bits() ^ other.bits())
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                fn complement(f) {
 | 
			
		||||
                    Self::from_bits_truncate(!f.bits())
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement iterators on the public (user-facing) bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_public_bitflags_iter {
 | 
			
		||||
    ($BitFlags:ident: $T:ty, $PublicBitFlags:ident) => {
 | 
			
		||||
        impl $BitFlags {
 | 
			
		||||
            /// Yield a set of contained flags values.
 | 
			
		||||
            ///
 | 
			
		||||
            /// Each yielded flags value will correspond to a defined named flag. Any unknown bits
 | 
			
		||||
            /// will be yielded together as a final flags value.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn iter(&self) -> $crate::iter::Iter<$PublicBitFlags> {
 | 
			
		||||
                $crate::iter::Iter::__private_const_new(
 | 
			
		||||
                    <$PublicBitFlags as $crate::Flags>::FLAGS,
 | 
			
		||||
                    $PublicBitFlags::from_bits_retain(self.bits()),
 | 
			
		||||
                    $PublicBitFlags::from_bits_retain(self.bits()),
 | 
			
		||||
                )
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            /// Yield a set of contained named flags values.
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method is like [`iter`](#method.iter), except only yields bits in contained named flags.
 | 
			
		||||
            /// Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            pub const fn iter_names(&self) -> $crate::iter::IterNames<$PublicBitFlags> {
 | 
			
		||||
                $crate::iter::IterNames::__private_const_new(
 | 
			
		||||
                    <$PublicBitFlags as $crate::Flags>::FLAGS,
 | 
			
		||||
                    $PublicBitFlags::from_bits_retain(self.bits()),
 | 
			
		||||
                    $PublicBitFlags::from_bits_retain(self.bits()),
 | 
			
		||||
                )
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::iter::IntoIterator for $BitFlags {
 | 
			
		||||
            type Item = $PublicBitFlags;
 | 
			
		||||
            type IntoIter = $crate::iter::Iter<$PublicBitFlags>;
 | 
			
		||||
 | 
			
		||||
            fn into_iter(self) -> Self::IntoIter {
 | 
			
		||||
                self.iter()
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement traits on the public (user-facing) bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_public_bitflags_ops {
 | 
			
		||||
    ($PublicBitFlags:ident) => {
 | 
			
		||||
        impl $crate::__private::core::fmt::Binary for $PublicBitFlags {
 | 
			
		||||
            fn fmt(
 | 
			
		||||
                &self,
 | 
			
		||||
                f: &mut $crate::__private::core::fmt::Formatter,
 | 
			
		||||
            ) -> $crate::__private::core::fmt::Result {
 | 
			
		||||
                $crate::__private::core::fmt::Binary::fmt(&self.0, f)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::fmt::Octal for $PublicBitFlags {
 | 
			
		||||
            fn fmt(
 | 
			
		||||
                &self,
 | 
			
		||||
                f: &mut $crate::__private::core::fmt::Formatter,
 | 
			
		||||
            ) -> $crate::__private::core::fmt::Result {
 | 
			
		||||
                $crate::__private::core::fmt::Octal::fmt(&self.0, f)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::fmt::LowerHex for $PublicBitFlags {
 | 
			
		||||
            fn fmt(
 | 
			
		||||
                &self,
 | 
			
		||||
                f: &mut $crate::__private::core::fmt::Formatter,
 | 
			
		||||
            ) -> $crate::__private::core::fmt::Result {
 | 
			
		||||
                $crate::__private::core::fmt::LowerHex::fmt(&self.0, f)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::fmt::UpperHex for $PublicBitFlags {
 | 
			
		||||
            fn fmt(
 | 
			
		||||
                &self,
 | 
			
		||||
                f: &mut $crate::__private::core::fmt::Formatter,
 | 
			
		||||
            ) -> $crate::__private::core::fmt::Result {
 | 
			
		||||
                $crate::__private::core::fmt::UpperHex::fmt(&self.0, f)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::BitOr for $PublicBitFlags {
 | 
			
		||||
            type Output = Self;
 | 
			
		||||
 | 
			
		||||
            /// The bitwise or (`|`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn bitor(self, other: $PublicBitFlags) -> Self {
 | 
			
		||||
                self.union(other)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::BitOrAssign for $PublicBitFlags {
 | 
			
		||||
            /// The bitwise or (`|`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn bitor_assign(&mut self, other: Self) {
 | 
			
		||||
                self.insert(other);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::BitXor for $PublicBitFlags {
 | 
			
		||||
            type Output = Self;
 | 
			
		||||
 | 
			
		||||
            /// The bitwise exclusive-or (`^`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn bitxor(self, other: Self) -> Self {
 | 
			
		||||
                self.symmetric_difference(other)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::BitXorAssign for $PublicBitFlags {
 | 
			
		||||
            /// The bitwise exclusive-or (`^`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn bitxor_assign(&mut self, other: Self) {
 | 
			
		||||
                self.toggle(other);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::BitAnd for $PublicBitFlags {
 | 
			
		||||
            type Output = Self;
 | 
			
		||||
 | 
			
		||||
            /// The bitwise and (`&`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn bitand(self, other: Self) -> Self {
 | 
			
		||||
                self.intersection(other)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::BitAndAssign for $PublicBitFlags {
 | 
			
		||||
            /// The bitwise and (`&`) of the bits in two flags values.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn bitand_assign(&mut self, other: Self) {
 | 
			
		||||
                *self = Self::from_bits_retain(self.bits()).intersection(other);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::Sub for $PublicBitFlags {
 | 
			
		||||
            type Output = Self;
 | 
			
		||||
 | 
			
		||||
            /// The intersection of a source flags value with the complement of a target flags value (`&!`).
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method is not equivalent to `self & !other` when `other` has unknown bits set.
 | 
			
		||||
            /// `difference` won't truncate `other`, but the `!` operator will.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn sub(self, other: Self) -> Self {
 | 
			
		||||
                self.difference(other)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::SubAssign for $PublicBitFlags {
 | 
			
		||||
            /// The intersection of a source flags value with the complement of a target flags value (`&!`).
 | 
			
		||||
            ///
 | 
			
		||||
            /// This method is not equivalent to `self & !other` when `other` has unknown bits set.
 | 
			
		||||
            /// `difference` won't truncate `other`, but the `!` operator will.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn sub_assign(&mut self, other: Self) {
 | 
			
		||||
                self.remove(other);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::ops::Not for $PublicBitFlags {
 | 
			
		||||
            type Output = Self;
 | 
			
		||||
 | 
			
		||||
            /// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
 | 
			
		||||
            #[inline]
 | 
			
		||||
            fn not(self) -> Self {
 | 
			
		||||
                self.complement()
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::iter::Extend<$PublicBitFlags> for $PublicBitFlags {
 | 
			
		||||
            /// The bitwise or (`|`) of the bits in each flags value.
 | 
			
		||||
            fn extend<T: $crate::__private::core::iter::IntoIterator<Item = Self>>(
 | 
			
		||||
                &mut self,
 | 
			
		||||
                iterator: T,
 | 
			
		||||
            ) {
 | 
			
		||||
                for item in iterator {
 | 
			
		||||
                    self.insert(item)
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::__private::core::iter::FromIterator<$PublicBitFlags> for $PublicBitFlags {
 | 
			
		||||
            /// The bitwise or (`|`) of the bits in each flags value.
 | 
			
		||||
            fn from_iter<T: $crate::__private::core::iter::IntoIterator<Item = Self>>(
 | 
			
		||||
                iterator: T,
 | 
			
		||||
            ) -> Self {
 | 
			
		||||
                use $crate::__private::core::iter::Extend;
 | 
			
		||||
 | 
			
		||||
                let mut result = Self::empty();
 | 
			
		||||
                result.extend(iterator);
 | 
			
		||||
                result
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Implement constants on the public (user-facing) bitflags type.
 | 
			
		||||
#[macro_export(local_inner_macros)]
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
macro_rules! __impl_public_bitflags_consts {
 | 
			
		||||
    (
 | 
			
		||||
        $PublicBitFlags:ident: $T:ty {
 | 
			
		||||
            $(
 | 
			
		||||
                $(#[$inner:ident $($args:tt)*])*
 | 
			
		||||
                const $Flag:tt = $value:expr;
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
    ) => {
 | 
			
		||||
        impl $PublicBitFlags {
 | 
			
		||||
            $(
 | 
			
		||||
                __bitflags_flag!({
 | 
			
		||||
                    name: $Flag,
 | 
			
		||||
                    named: {
 | 
			
		||||
                        $(#[$inner $($args)*])*
 | 
			
		||||
                        #[allow(
 | 
			
		||||
                            deprecated,
 | 
			
		||||
                            non_upper_case_globals,
 | 
			
		||||
                        )]
 | 
			
		||||
                        pub const $Flag: Self = Self::from_bits_retain($value);
 | 
			
		||||
                    },
 | 
			
		||||
                    unnamed: {},
 | 
			
		||||
                });
 | 
			
		||||
            )*
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        impl $crate::Flags for $PublicBitFlags {
 | 
			
		||||
            const FLAGS: &'static [$crate::Flag<$PublicBitFlags>] = &[
 | 
			
		||||
                $(
 | 
			
		||||
                    __bitflags_flag!({
 | 
			
		||||
                        name: $Flag,
 | 
			
		||||
                        named: {
 | 
			
		||||
                            __bitflags_expr_safe_attrs!(
 | 
			
		||||
                                $(#[$inner $($args)*])*
 | 
			
		||||
                                {
 | 
			
		||||
                                    #[allow(
 | 
			
		||||
                                        deprecated,
 | 
			
		||||
                                        non_upper_case_globals,
 | 
			
		||||
                                    )]
 | 
			
		||||
                                    $crate::Flag::new($crate::__private::core::stringify!($Flag), $PublicBitFlags::$Flag)
 | 
			
		||||
                                }
 | 
			
		||||
                            )
 | 
			
		||||
                        },
 | 
			
		||||
                        unnamed: {
 | 
			
		||||
                            __bitflags_expr_safe_attrs!(
 | 
			
		||||
                                $(#[$inner $($args)*])*
 | 
			
		||||
                                {
 | 
			
		||||
                                    #[allow(
 | 
			
		||||
                                        deprecated,
 | 
			
		||||
                                        non_upper_case_globals,
 | 
			
		||||
                                    )]
 | 
			
		||||
                                    $crate::Flag::new("", $PublicBitFlags::from_bits_retain($value))
 | 
			
		||||
                                }
 | 
			
		||||
                            )
 | 
			
		||||
                        },
 | 
			
		||||
                    }),
 | 
			
		||||
                )*
 | 
			
		||||
            ];
 | 
			
		||||
 | 
			
		||||
            type Bits = $T;
 | 
			
		||||
 | 
			
		||||
            fn bits(&self) -> $T {
 | 
			
		||||
                $PublicBitFlags::bits(self)
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            fn from_bits_retain(bits: $T) -> $PublicBitFlags {
 | 
			
		||||
                $PublicBitFlags::from_bits_retain(bits)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										131
									
								
								vendor/bitflags/src/tests.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										131
									
								
								vendor/bitflags/src/tests.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,131 @@
 | 
			
		||||
mod all;
 | 
			
		||||
mod bits;
 | 
			
		||||
mod complement;
 | 
			
		||||
mod contains;
 | 
			
		||||
mod difference;
 | 
			
		||||
mod empty;
 | 
			
		||||
mod eq;
 | 
			
		||||
mod extend;
 | 
			
		||||
mod flags;
 | 
			
		||||
mod fmt;
 | 
			
		||||
mod from_bits;
 | 
			
		||||
mod from_bits_retain;
 | 
			
		||||
mod from_bits_truncate;
 | 
			
		||||
mod from_name;
 | 
			
		||||
mod insert;
 | 
			
		||||
mod intersection;
 | 
			
		||||
mod intersects;
 | 
			
		||||
mod is_all;
 | 
			
		||||
mod is_empty;
 | 
			
		||||
mod iter;
 | 
			
		||||
mod parser;
 | 
			
		||||
mod remove;
 | 
			
		||||
mod symmetric_difference;
 | 
			
		||||
mod union;
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestFlags: u8 {
 | 
			
		||||
        /// 1
 | 
			
		||||
        const A = 1;
 | 
			
		||||
 | 
			
		||||
        /// 1 << 1
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
 | 
			
		||||
        /// 1 << 2
 | 
			
		||||
        const C = 1 << 2;
 | 
			
		||||
 | 
			
		||||
        /// 1 | (1 << 1) | (1 << 2)
 | 
			
		||||
        const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestFlagsInvert: u8 {
 | 
			
		||||
        /// 1 | (1 << 1) | (1 << 2)
 | 
			
		||||
        const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
 | 
			
		||||
 | 
			
		||||
        /// 1
 | 
			
		||||
        const A = 1;
 | 
			
		||||
 | 
			
		||||
        /// 1 << 1
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
 | 
			
		||||
        /// 1 << 2
 | 
			
		||||
        const C = 1 << 2;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestZero: u8 {
 | 
			
		||||
        /// 0
 | 
			
		||||
        const ZERO = 0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestZeroOne: u8 {
 | 
			
		||||
        /// 0
 | 
			
		||||
        const ZERO = 0;
 | 
			
		||||
 | 
			
		||||
        /// 1
 | 
			
		||||
        const ONE = 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestUnicode: u8 {
 | 
			
		||||
        /// 1
 | 
			
		||||
        const 一 = 1;
 | 
			
		||||
 | 
			
		||||
        /// 2
 | 
			
		||||
        const 二 = 1 << 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestEmpty: u8 {}
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestOverlapping: u8 {
 | 
			
		||||
        /// 1 | (1 << 1)
 | 
			
		||||
        const AB = 1 | (1 << 1);
 | 
			
		||||
 | 
			
		||||
        /// (1 << 1) | (1 << 2)
 | 
			
		||||
        const BC = (1 << 1) | (1 << 2);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestOverlappingFull: u8 {
 | 
			
		||||
        /// 1
 | 
			
		||||
        const A = 1;
 | 
			
		||||
 | 
			
		||||
        /// 1
 | 
			
		||||
        const B = 1;
 | 
			
		||||
 | 
			
		||||
        /// 1
 | 
			
		||||
        const C = 1;
 | 
			
		||||
 | 
			
		||||
        /// 2
 | 
			
		||||
        const D = 1 << 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestExternal: u8 {
 | 
			
		||||
        /// 1
 | 
			
		||||
        const A = 1;
 | 
			
		||||
 | 
			
		||||
        /// 1 << 1
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
 | 
			
		||||
        /// 1 << 2
 | 
			
		||||
        const C = 1 << 2;
 | 
			
		||||
 | 
			
		||||
        /// 1 | (1 << 1) | (1 << 2)
 | 
			
		||||
        const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
 | 
			
		||||
 | 
			
		||||
        /// External
 | 
			
		||||
        const _ = !0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
 | 
			
		||||
    pub struct TestExternalFull: u8 {
 | 
			
		||||
        /// External
 | 
			
		||||
        const _ = !0;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										430
									
								
								vendor/bitflags/src/traits.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										430
									
								
								vendor/bitflags/src/traits.rs
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,430 @@
 | 
			
		||||
use core::{
 | 
			
		||||
    fmt,
 | 
			
		||||
    ops::{BitAnd, BitOr, BitXor, Not},
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
use crate::{
 | 
			
		||||
    iter,
 | 
			
		||||
    parser::{ParseError, ParseHex, WriteHex},
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
A defined flags value that may be named or unnamed.
 | 
			
		||||
*/
 | 
			
		||||
pub struct Flag<B> {
 | 
			
		||||
    name: &'static str,
 | 
			
		||||
    value: B,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B> Flag<B> {
 | 
			
		||||
    /**
 | 
			
		||||
    Define a flag.
 | 
			
		||||
 | 
			
		||||
    If `name` is non-empty then the flag is named, otherwise it's unnamed.
 | 
			
		||||
    */
 | 
			
		||||
    pub const fn new(name: &'static str, value: B) -> Self {
 | 
			
		||||
        Flag { name, value }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
    Get the name of this flag.
 | 
			
		||||
 | 
			
		||||
    If the flag is unnamed then the returned string will be empty.
 | 
			
		||||
    */
 | 
			
		||||
    pub const fn name(&self) -> &'static str {
 | 
			
		||||
        self.name
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
    Get the flags value of this flag.
 | 
			
		||||
    */
 | 
			
		||||
    pub const fn value(&self) -> &B {
 | 
			
		||||
        &self.value
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
    Whether the flag is named.
 | 
			
		||||
 | 
			
		||||
    If [`Flag::name`] returns a non-empty string then this method will return `true`.
 | 
			
		||||
    */
 | 
			
		||||
    pub const fn is_named(&self) -> bool {
 | 
			
		||||
        !self.name.is_empty()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
    Whether the flag is unnamed.
 | 
			
		||||
 | 
			
		||||
    If [`Flag::name`] returns a non-empty string then this method will return `false`.
 | 
			
		||||
    */
 | 
			
		||||
    pub const fn is_unnamed(&self) -> bool {
 | 
			
		||||
        self.name.is_empty()
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
A set of defined flags using a bits type as storage.
 | 
			
		||||
 | 
			
		||||
## Implementing `Flags`
 | 
			
		||||
 | 
			
		||||
This trait is implemented by the [`bitflags`](macro.bitflags.html) macro:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
use bitflags::bitflags;
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct MyFlags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
It can also be implemented manually:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
use bitflags::{Flag, Flags};
 | 
			
		||||
 | 
			
		||||
struct MyFlags(u8);
 | 
			
		||||
 | 
			
		||||
impl Flags for MyFlags {
 | 
			
		||||
    const FLAGS: &'static [Flag<Self>] = &[
 | 
			
		||||
        Flag::new("A", MyFlags(1)),
 | 
			
		||||
        Flag::new("B", MyFlags(1 << 1)),
 | 
			
		||||
    ];
 | 
			
		||||
 | 
			
		||||
    type Bits = u8;
 | 
			
		||||
 | 
			
		||||
    fn from_bits_retain(bits: Self::Bits) -> Self {
 | 
			
		||||
        MyFlags(bits)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fn bits(&self) -> Self::Bits {
 | 
			
		||||
        self.0
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Using `Flags`
 | 
			
		||||
 | 
			
		||||
The `Flags` trait can be used generically to work with any flags types. In this example,
 | 
			
		||||
we can count the number of defined named flags:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
# use bitflags::{bitflags, Flags};
 | 
			
		||||
fn defined_flags<F: Flags>() -> usize {
 | 
			
		||||
    F::FLAGS.iter().filter(|f| f.is_named()).count()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bitflags! {
 | 
			
		||||
    struct MyFlags: u8 {
 | 
			
		||||
        const A = 1;
 | 
			
		||||
        const B = 1 << 1;
 | 
			
		||||
        const C = 1 << 2;
 | 
			
		||||
 | 
			
		||||
        const _ = !0;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
assert_eq!(3, defined_flags::<MyFlags>());
 | 
			
		||||
```
 | 
			
		||||
*/
 | 
			
		||||
pub trait Flags: Sized + 'static {
 | 
			
		||||
    /// The set of defined flags.
 | 
			
		||||
    const FLAGS: &'static [Flag<Self>];
 | 
			
		||||
 | 
			
		||||
    /// The underlying bits type.
 | 
			
		||||
    type Bits: Bits;
 | 
			
		||||
 | 
			
		||||
    /// Get a flags value with all bits unset.
 | 
			
		||||
    fn empty() -> Self {
 | 
			
		||||
        Self::from_bits_retain(Self::Bits::EMPTY)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Get a flags value with all known bits set.
 | 
			
		||||
    fn all() -> Self {
 | 
			
		||||
        let mut truncated = Self::Bits::EMPTY;
 | 
			
		||||
 | 
			
		||||
        for flag in Self::FLAGS.iter() {
 | 
			
		||||
            truncated = truncated | flag.value().bits();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        Self::from_bits_retain(truncated)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Get the underlying bits value.
 | 
			
		||||
    ///
 | 
			
		||||
    /// The returned value is exactly the bits set in this flags value.
 | 
			
		||||
    fn bits(&self) -> Self::Bits;
 | 
			
		||||
 | 
			
		||||
    /// Convert from a bits value.
 | 
			
		||||
    ///
 | 
			
		||||
    /// This method will return `None` if any unknown bits are set.
 | 
			
		||||
    fn from_bits(bits: Self::Bits) -> Option<Self> {
 | 
			
		||||
        let truncated = Self::from_bits_truncate(bits);
 | 
			
		||||
 | 
			
		||||
        if truncated.bits() == bits {
 | 
			
		||||
            Some(truncated)
 | 
			
		||||
        } else {
 | 
			
		||||
            None
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Convert from a bits value, unsetting any unknown bits.
 | 
			
		||||
    fn from_bits_truncate(bits: Self::Bits) -> Self {
 | 
			
		||||
        Self::from_bits_retain(bits & Self::all().bits())
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Convert from a bits value exactly.
 | 
			
		||||
    fn from_bits_retain(bits: Self::Bits) -> Self;
 | 
			
		||||
 | 
			
		||||
    /// Get a flags value with the bits of a flag with the given name set.
 | 
			
		||||
    ///
 | 
			
		||||
    /// This method will return `None` if `name` is empty or doesn't
 | 
			
		||||
    /// correspond to any named flag.
 | 
			
		||||
    fn from_name(name: &str) -> Option<Self> {
 | 
			
		||||
        // Don't parse empty names as empty flags
 | 
			
		||||
        if name.is_empty() {
 | 
			
		||||
            return None;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        for flag in Self::FLAGS {
 | 
			
		||||
            if flag.name() == name {
 | 
			
		||||
                return Some(Self::from_bits_retain(flag.value().bits()));
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        None
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Yield a set of contained flags values.
 | 
			
		||||
    ///
 | 
			
		||||
    /// Each yielded flags value will correspond to a defined named flag. Any unknown bits
 | 
			
		||||
    /// will be yielded together as a final flags value.
 | 
			
		||||
    fn iter(&self) -> iter::Iter<Self> {
 | 
			
		||||
        iter::Iter::new(self)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Yield a set of contained named flags values.
 | 
			
		||||
    ///
 | 
			
		||||
    /// This method is like [`Flags::iter`], except only yields bits in contained named flags.
 | 
			
		||||
    /// Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
 | 
			
		||||
    fn iter_names(&self) -> iter::IterNames<Self> {
 | 
			
		||||
        iter::IterNames::new(self)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Whether all bits in this flags value are unset.
 | 
			
		||||
    fn is_empty(&self) -> bool {
 | 
			
		||||
        self.bits() == Self::Bits::EMPTY
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Whether all known bits in this flags value are set.
 | 
			
		||||
    fn is_all(&self) -> bool {
 | 
			
		||||
        // NOTE: We check against `Self::all` here, not `Self::Bits::ALL`
 | 
			
		||||
        // because the set of all flags may not use all bits
 | 
			
		||||
        Self::all().bits() | self.bits() == self.bits()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Whether any set bits in a source flags value are also set in a target flags value.
 | 
			
		||||
    fn intersects(&self, other: Self) -> bool
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized,
 | 
			
		||||
    {
 | 
			
		||||
        self.bits() & other.bits() != Self::Bits::EMPTY
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Whether all set bits in a source flags value are also set in a target flags value.
 | 
			
		||||
    fn contains(&self, other: Self) -> bool
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized,
 | 
			
		||||
    {
 | 
			
		||||
        self.bits() & other.bits() == other.bits()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The bitwise or (`|`) of the bits in two flags values.
 | 
			
		||||
    fn insert(&mut self, other: Self)
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized,
 | 
			
		||||
    {
 | 
			
		||||
        *self = Self::from_bits_retain(self.bits()).union(other);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The intersection of a source flags value with the complement of a target flags value (`&!`).
 | 
			
		||||
    ///
 | 
			
		||||
    /// This method is not equivalent to `self & !other` when `other` has unknown bits set.
 | 
			
		||||
    /// `remove` won't truncate `other`, but the `!` operator will.
 | 
			
		||||
    fn remove(&mut self, other: Self)
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized,
 | 
			
		||||
    {
 | 
			
		||||
        *self = Self::from_bits_retain(self.bits()).difference(other);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The bitwise exclusive-or (`^`) of the bits in two flags values.
 | 
			
		||||
    fn toggle(&mut self, other: Self)
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized,
 | 
			
		||||
    {
 | 
			
		||||
        *self = Self::from_bits_retain(self.bits()).symmetric_difference(other);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// Call [`Flags::insert`] when `value` is `true` or [`Flags::remove`] when `value` is `false`.
 | 
			
		||||
    fn set(&mut self, other: Self, value: bool)
 | 
			
		||||
    where
 | 
			
		||||
        Self: Sized,
 | 
			
		||||
    {
 | 
			
		||||
        if value {
 | 
			
		||||
            self.insert(other);
 | 
			
		||||
        } else {
 | 
			
		||||
            self.remove(other);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The bitwise and (`&`) of the bits in two flags values.
 | 
			
		||||
    #[must_use]
 | 
			
		||||
    fn intersection(self, other: Self) -> Self {
 | 
			
		||||
        Self::from_bits_retain(self.bits() & other.bits())
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The bitwise or (`|`) of the bits in two flags values.
 | 
			
		||||
    #[must_use]
 | 
			
		||||
    fn union(self, other: Self) -> Self {
 | 
			
		||||
        Self::from_bits_retain(self.bits() | other.bits())
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The intersection of a source flags value with the complement of a target flags value (`&!`).
 | 
			
		||||
    ///
 | 
			
		||||
    /// This method is not equivalent to `self & !other` when `other` has unknown bits set.
 | 
			
		||||
    /// `difference` won't truncate `other`, but the `!` operator will.
 | 
			
		||||
    #[must_use]
 | 
			
		||||
    fn difference(self, other: Self) -> Self {
 | 
			
		||||
        Self::from_bits_retain(self.bits() & !other.bits())
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The bitwise exclusive-or (`^`) of the bits in two flags values.
 | 
			
		||||
    #[must_use]
 | 
			
		||||
    fn symmetric_difference(self, other: Self) -> Self {
 | 
			
		||||
        Self::from_bits_retain(self.bits() ^ other.bits())
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
 | 
			
		||||
    #[must_use]
 | 
			
		||||
    fn complement(self) -> Self {
 | 
			
		||||
        Self::from_bits_truncate(!self.bits())
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
A bits type that can be used as storage for a flags type.
 | 
			
		||||
*/
 | 
			
		||||
pub trait Bits:
 | 
			
		||||
    Clone
 | 
			
		||||
    + Copy
 | 
			
		||||
    + PartialEq
 | 
			
		||||
    + BitAnd<Output = Self>
 | 
			
		||||
    + BitOr<Output = Self>
 | 
			
		||||
    + BitXor<Output = Self>
 | 
			
		||||
    + Not<Output = Self>
 | 
			
		||||
    + Sized
 | 
			
		||||
    + 'static
 | 
			
		||||
{
 | 
			
		||||
    /// A value with all bits unset.
 | 
			
		||||
    const EMPTY: Self;
 | 
			
		||||
 | 
			
		||||
    /// A value with all bits set.
 | 
			
		||||
    const ALL: Self;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Not re-exported: prevent custom `Bits` impls being used in the `bitflags!` macro,
 | 
			
		||||
// or they may fail to compile based on crate features
 | 
			
		||||
pub trait Primitive {}
 | 
			
		||||
 | 
			
		||||
macro_rules! impl_bits {
 | 
			
		||||
    ($($u:ty, $i:ty,)*) => {
 | 
			
		||||
        $(
 | 
			
		||||
            impl Bits for $u {
 | 
			
		||||
                const EMPTY: $u = 0;
 | 
			
		||||
                const ALL: $u = <$u>::MAX;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            impl Bits for $i {
 | 
			
		||||
                const EMPTY: $i = 0;
 | 
			
		||||
                const ALL: $i = <$u>::MAX as $i;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            impl ParseHex for $u {
 | 
			
		||||
                fn parse_hex(input: &str) -> Result<Self, ParseError> {
 | 
			
		||||
                    <$u>::from_str_radix(input, 16).map_err(|_| ParseError::invalid_hex_flag(input))
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            impl ParseHex for $i {
 | 
			
		||||
                fn parse_hex(input: &str) -> Result<Self, ParseError> {
 | 
			
		||||
                    <$i>::from_str_radix(input, 16).map_err(|_| ParseError::invalid_hex_flag(input))
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            impl WriteHex for $u {
 | 
			
		||||
                fn write_hex<W: fmt::Write>(&self, mut writer: W) -> fmt::Result {
 | 
			
		||||
                    write!(writer, "{:x}", self)
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            impl WriteHex for $i {
 | 
			
		||||
                fn write_hex<W: fmt::Write>(&self, mut writer: W) -> fmt::Result {
 | 
			
		||||
                    write!(writer, "{:x}", self)
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            impl Primitive for $i {}
 | 
			
		||||
            impl Primitive for $u {}
 | 
			
		||||
        )*
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl_bits! {
 | 
			
		||||
    u8, i8,
 | 
			
		||||
    u16, i16,
 | 
			
		||||
    u32, i32,
 | 
			
		||||
    u64, i64,
 | 
			
		||||
    u128, i128,
 | 
			
		||||
    usize, isize,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// A trait for referencing the `bitflags`-owned internal type
 | 
			
		||||
/// without exposing it publicly.
 | 
			
		||||
pub trait PublicFlags {
 | 
			
		||||
    /// The type of the underlying storage.
 | 
			
		||||
    type Primitive: Primitive;
 | 
			
		||||
 | 
			
		||||
    /// The type of the internal field on the generated flags type.
 | 
			
		||||
    type Internal;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
#[deprecated(note = "use the `Flags` trait instead")]
 | 
			
		||||
pub trait BitFlags: ImplementedByBitFlagsMacro + Flags {
 | 
			
		||||
    /// An iterator over enabled flags in an instance of the type.
 | 
			
		||||
    type Iter: Iterator<Item = Self>;
 | 
			
		||||
 | 
			
		||||
    /// An iterator over the raw names and bits for enabled flags in an instance of the type.
 | 
			
		||||
    type IterNames: Iterator<Item = (&'static str, Self)>;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#[allow(deprecated)]
 | 
			
		||||
impl<B: Flags> BitFlags for B {
 | 
			
		||||
    type Iter = iter::Iter<Self>;
 | 
			
		||||
    type IterNames = iter::IterNames<Self>;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
impl<B: Flags> ImplementedByBitFlagsMacro for B {}
 | 
			
		||||
 | 
			
		||||
/// A marker trait that signals that an implementation of `BitFlags` came from the `bitflags!` macro.
 | 
			
		||||
///
 | 
			
		||||
/// There's nothing stopping an end-user from implementing this trait, but we don't guarantee their
 | 
			
		||||
/// manual implementations won't break between non-breaking releases.
 | 
			
		||||
#[doc(hidden)]
 | 
			
		||||
pub trait ImplementedByBitFlagsMacro {}
 | 
			
		||||
 | 
			
		||||
pub(crate) mod __private {
 | 
			
		||||
    pub use super::{ImplementedByBitFlagsMacro, PublicFlags};
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user