ã§#rustc 1.93.0 (254b59607 2026-01-19)Á³VOÐêùÿ²?ÑL¼�§Ì±-a7a40eb546f9e2b0Áë&Gf·Ã ¬ëñq:¤»b-bb76018b1173caf6Á‰example_generatedÁŒ�ò¶<åñŠœïñìåñtestsÁ,²òà$§ò³_coreÁbitflagsÁ__impl_all_bitflagsÁ__impl_bitflagsÁ³é,ÇHõDÜV„œÿ\ž|™düÓ¡±üÓOL A typesafe bitmask flag generator useful for sets of C-style bitmask flags.Áü£@= It can be used for creating typesafe wrappers around C APIs.ÁäËüèMJ The `bitflags!` macro generates `struct`s that manage a set of flags. TheÁü¶MJ flags should only be defined for integer types, otherwise unexpected typeÁü„%" errors may occur at compile time.ÁªËl®
>; assert_eq!((e1 - e2), Flags::A); // set differenceÁüà
>; assert_eq!(!e2, Flags::A); // set complementÁ,Ÿ�<¥¾Ëü±eb See [`example_generated::Flags`](./example_generated/struct.Flags.html) for documentation of codeÁü—1. generated by the above `bitflags!` expansion.ÁÉËüÍDA The generated `struct`s can also be extended with type and traitÁ¤’
implementations:Á§
Ë<«
¾Œ³
use std::fmt;ÁÅ
ËÜÉ
Íå
Ë|é
ûÜù
’ü•!¶ü·!àLÙÿ,ã�éË„í
impl Flags {Áüþ! pub fn clear(&mut self) {Áü OL self.bits = 0; // The `bits` field can be accessed from within theÁüðSP // same module where the `bitflags!` macro was invoked.ÁLÄÿ,Î�ÔËüØ! impl fmt::Display for Flags {Áüú>; fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {Áä¹ write!(f, "hi!")ÁLÖÿ,à�æË|ê¨ üú,) let mut flags = Flags::A | Flags::B;Á´§ flags.clear();Áü¾" assert!(flags.is_empty());Áüá0- assert_eq!(format!("{}", flags), "hi!");Áü’B? assert_eq!(format!("{:?}", Flags::A | Flags::B), "A | B");ÁüÕ30 assert_eq!(format!("{:?}", Flags::B), "B");Á,‰�<�¾—Ë„›
# VisibilityÁ¬Ëü°NK The generated structs and their associated flag constants are not exportedÁüÿMJ out of the current module by default. A definition can be exported out ofÁüÍ74 the current module by adding `pub` before `struct`:Á…Ë<‰¾Œ‘ mod example {Áü£ use bitflags::bitflags;ÁÃËœÇ bitflags! {ÁüÛ$! pub struct Flags1: u32 {Áü€%" const A = 0b00000001;Ál¦
}Á´Ë|¸ # pubÁüÈ struct Flags2: u32 {Áüé%" const B = 0b00000010;Ál�§L�ÿ,§�Ë|±¨ üÁ'$ let flag1 = example::Flags1::A;ÁüéFC let flag2 = example::Flags2::B; // error: const `B` is privateÁ,°�<¶¾¾Ë„Â
# AttributesÁÓËü×IF Attributes can be attached to the generated `struct`s by placing themÁü¡ before the `struct` keyword.ÁÂË´Æ ## RepresentationsÁÝËüáRO It's valid to add a `#[repr(C)]` or `#[repr(transparent)]` attribute to a typeÁü´UR generated by `bitflags!`. In these cases, the type is guaranteed to be a newtype.ÁŠË<Ž¾Ü–ͲË|¶ûäÆ #[repr(transparent)]ÁÜã’üÿ!¶ü¡!àüÃ!ŠLåÿ,ï�<õ¾ýËÜ� # Trait implementationsÁ�Ëü¡JG The `Copy`, `Clone`, `PartialEq`, `Eq`, `PartialOrd`, `Ord` and `Hash`ÁüìTQ traits are automatically derived for the `struct`s using the `derive` attribute.ÁüÁFC Additional traits can be derived by providing an explicit `derive`ÁÔˆ attribute on `struct`.Á£ Ëü§ MJ The `Extend` and `FromIterator` traits are implemented for the `struct`s,Áüõ PM too: `Extend` adds the union of the instances of the `struct` iterated over,ÁüÆ!.+ while `FromIterator` calculates the union.Áõ!Ëüù!MJ The `Binary`, `Debug`, `LowerHex`, `Octal` and `UpperHex` traits are alsoÁüÇ"DA implemented by displaying the bits value of the internal struct.ÁŒ#Ë„�#
## OperatorsÁ¡#Ëü¥#NK The following operator traits are implemented for the generated `struct`s:Áô#Ëüø#&# - `BitOr` and `BitOrAssign`: unionÁüŸ$/, - `BitAnd` and `BitAndAssign`: intersectionÁüÏ$)& - `BitXor` and `BitXorAssign`: toggleÁüù$+( - `Sub` and `SubAssign`: set differenceÁÜ¥% - `Not`: set complementÁÁ%ËlÅ%
# MethodsÁÓ%Ëü×%B? The following methods are defined for the generated `struct`s:Áš&Ëüž&$! - `empty`: an empty set of flagsÁüÃ&)& - `all`: the set of all defined flagsÁüí&96 - `bits`: the raw value of the flags currently storedÁü§'JG - `from_bits`: convert from underlying bit representation, unless thatÁüò'KH representation contains bits that do not correspond to aÁü¾( defined flagÁüÞ(PM - `from_bits_truncate`: convert from underlying bit representation, droppingÁü¯)LI any bits that do not correspond to defined flagsÁüü)PM - `from_bits_unchecked`: convert from underlying bit representation, keepingÁüÍ*NK all bits (even those not corresponding to definedÁüœ+# flags)ÁüÀ+96 - `is_empty`: `true` if no flags are currently storedÁüú+MJ - `is_all`: `true` if currently set flags exactly equal all defined flagsÁüÈ,OL - `intersects`: `true` if there are flags common to both `self` and `other`Áü˜-SP - `contains`: `true` if all of the flags in `other` are contained within `self`Áüì-41 - `insert`: inserts the specified flags in-placeÁü¡.41 - `remove`: removes the specified flags in-placeÁüÖ.PM - `toggle`: the specified flags will be inserted if not present, and removedÁä§/ if they are.ÁüÄ/QN - `set`: inserts or removes the specified flags depending on the passed valueÁü–0SP - `intersection`: returns a new set of flags, containing only the flags presentÁüê0PM in both `self` and `other` (the argument to the function).Áü»1JG - `union`: returns a new set of flags, containing any flags present inÁü†2GD either `self` or `other` (the argument to the function).ÁüÎ2OL - `difference`: returns a new set of flags, containing all flags present inÁüž3KH `self` without any of the flags present in `other` (theÁüê3.+ argument to the function).Áü™4NK - `symmetric_difference`: returns a new set of flags, containing all flagsÁüè4OL present in either `self` or `other` (the argumentÁü¸5=: to the function), but not both.Áüö5NK - `complement`: returns a new set of flags, containing all flags which areÁüÅ6KH not set in `self`, but which are allowed for this type.Á‘7Ët•7 ## DefaultÁ¤7Ëü¨7SP The `Default` trait is not automatically implemented for the generated structs.Áü7Ëü€8WT If your default value is equal to `0` (which is the same value as calling `empty()`ÁüØ8>; on the generated struct), you can simply derive `Default`:Á—9Ë<›9¾Ü£9Í¿9Ë|Ã9ûüÓ90- // Results in default value with bits: 0ÁÔ„: #[derive(Default)]ÁÜŸ:’ü»:!¶üÝ:!àüÿ:!ŠL¡;ÿ,«;�±;Ë|µ;¨ üÅ;85 let derived_default: Flags = Default::default();Áüþ;.+ assert_eq!(derived_default.bits(), 0);Á,<�<³<¾»<Ëü¿<WT If your default value is not equal to `0` you need to implement `Default` yourself:Á—=Ë<›=¾Ü£=Í¿=Ë|Ã=ûÜÓ=’üï=!¶ü‘>!àü³>!ŠLÕ>ÿ,ß>�å>Ëüé>(% // explicit `Default` implementationÁä’? impl Default for Flags {Áü¯? fn default() -> Flags {ÁüÏ? Flags::A | Flags::CÁLï?ÿ,ù?�ÿ?Ë|ƒ@¨ ü“@<9 let implemented_default: Flags = Default::default();ÁüÐ@?< assert_eq!(implemented_default, (Flags::A | Flags::C));Á,�A�<–A¾žAË„¢A
# Zero FlagsÁ³AËü·Aa^ Flags with a value equal to zero will have some strange behavior that one should be aware of.Á™BË<�B¾Ü¥BÍÁBË|ÅBûÜÕB’üñB$! const NONE = 0b00000000;
¯‚< Returns an empty set of flags.Áü¾‚"+í‚î‚õ‚8þ4ï‚8ƒƒ8,‡ƒ8�ƒ8emptyÁ,�ƒ•ƒ–ƒ(˜ƒ8$›ƒ ƒÏƒ8$²ƒ·ƒÁƒ8¥_$¹ƒ&½ƒ7쿃<& Returns the set containing all flags.ÁüÞƒ)+”„•„œ„8þ4–„8ª„8,®„8´„8à·„º„»„(½„8$À„Å„Û†8„œ×„ê„ì„͆,‚…8ÁYDƒ…&‹…,�…8™Ž…�…»†,ª…«…¤†,É…Ê…Ý…+Ë…Ì…Ü…,Í…8Î$Î…,Ó…Ô…Ú…,Õ…8þ$Ö…
Û…
Þ…,ü…8Ú[$ý…‚†,„†8˜,…†%Š†
¥†<5 Returns the raw value of the flags currently store
,½‹8,¾‹'Ë8é,Å‹'Ê‹8ä4Ì‹'Ò‹8Ó4Ô‹'Ú‹8Ð$Ü‹<> Convert from underlying bit representation, dropping any bitsÁüŽŒA<! that do not correspond to flags.ÁüÜŒ$+��Ž�•�8þ4��8£�8,§�8�8from_bits_truncateÁ”°�Â�Ë�8¥_$Ã�&Ç�,É�8™Ê�(Í�8$Ð�Õ�šŽ8$ç�ì�ŒŽ
Dô«8Š¬8,Ž¬8”¬8C,—¬œ¬®¬8$�¬$¡¬8î,£¬&¨¬8$ª¬(°¬8$³¬¸¬ü¬8$ʬϬî¬8¥_$Ѭ&Õ¬8$׬۬8¥_$ܬá¬8î,ã¬è¬8¥_$é¬<@ Returns the difference between the flags in `self` and `other`.Áü‹C<ËÛ<= Specifically, the returned set contains all flags present inÁüë@<0 `self`, except for the ones present in `other`.Áü¸®3<Ëø®<A It is also conceptually equivalent to the "bit-clear" operation:Áüˆ¯D<6 `flags & !other` (and this syntax is also supported).ÁüÙ¯9<ËŸ°<3 This is equivalent to using the `-` operator (e.g.Áü¯°6<& [`ops::Sub`]), as in `flags - other`.Áüò°)<˨±<? [`ops::Sub`]: https://doc.rust-lang.org/std/ops/trait.Sub.htmlÁü¸±B+‡²ˆ²�²8þ4‰²+�²ž²§²8÷
8¥_$�³&…³8$‡³‹³8¥_$Œ³‘³“³8î,”³™³8¥_$š³<? Returns the [symmetric difference][sym-diff] between the flagsÁü¼³B< in `self` and `other`.ÁÔ‹´<˲´<@ Specifically, the returned set contains the flags present whichÁü´C<> are present in `self` or `other`, but that are not present inÁü’µA<> both. Equivalently, it contains the flags present in *exactlyÁüàµA<% one* of the sets `self` and `other`.Áü®¶(<Ëã¶<3 This is equivalent to using the `^` operator (e.g.Áüó¶6<) [`ops::BitXor`]), as in `flags ^ other`.Áü¶·,<Ëï·<? [sym-diff]: https://en.wikipedia.org/wiki/Symmetric_differenceÁüÿ·B<E [`ops::BitXor`]: https://doc.rust-lang.org/std/ops/trait.BitXor.htmlÁüθH+£¹¤¹«¹8þ4¥¹+¹¹º¹Ã¹8÷
D»¹8ѹ8,Õ¹8Û¹8symmetric_differenceÁ¤Þ¹ò¹„º8$ó¹$÷¹8î,ù¹&þ¹8$€º(†º8$‰ºŽºÒº8$ º¥ºÄº8¥_$§º&«º8$º±º8¥_$²º·º8î,¹º¾º8¥_$¿º<- Returns the complement of this set of flags.Áüáº0<Ëž»<@ Specifically, the returned set contains all the flags which areÁü®»C<8 not set in `self`, but which are allowed for this type.Áüþ»;<ËƼ<: Alternatively, it can be thought of as the set differenceÁüÖ¼=<? between [`Self::all()`] and `self` (e.g. `Self::all() - self`)Áü ½B<Ëï½<3 This is equivalent to using the `!` operator (e.g.Áüÿ½6< [`ops::Not`]), as in `!flags`.Áü¾"<Ëñ¾< [`Self::all()`]: Self::allÁô�¿<? [`ops::Not`]: https://doc.rust-lang.org/std/ops/trait.Not.htmlÁü¬¿B+û¿ü¿ƒÀ8þ4ý¿+‘À’À›À8÷
ÇÁ,ËÁ8ÁYDÌÁÕÁÍÃ8!$ãÁ8Ø4èÁïÁ8$ñÁ%õÁ<, Returns the union of the two sets of flags.Áü„Â/+ÀÂÁÂÈÂ8þ4ÂÂ8ÖÂ8í,ÙÂÞÂõÂ8$ßÂ$ãÂ8î,åÂ&êÂ,ìÂ8ÁYDíÂ(÷Â8$úÂÿÂÃÃ8$‘ÖõÃ8¥_$˜Ã&œÃ8$žÃ¢Ã8¥_$£Ã¨Ã8î,ªÃ¯Ã8¥_$°Ã8$ØÃ,ÝÃ8,ÞÃ'ãÃ8é,åÃ'êÃ8ÞìÃ'ïÃ8BitOrAssignÁ\ñÃ8
ýÃ,�Ä8ÁYD‚Ä‹Ä¿Å< Adds the set of flags.ÁÔ™Ä+ÀÄÁÄÈÄ8þ4ÂÄ8ÖÄ8îdÙÄåÄüÄæÄ8çÄ8$ëÄ$ïÄ8î,ñÄ&öÄ8$øÄþĵÅ8$�Å”Å8¥_$•ÅšÅ8î,�Å¢Å8¥_$£Å%§Å8$ÊÅ,ÏÅ8,ÐÅ'ÕÅ8é,×Å'ÜÅ8ÞÞÅ'áÅ8BitXorÁ4ãÅ8
êÅ,îÅ8ÁYDïÅøÅþÇ8!$†Æ8Ø4‹Æ’Æ8$”Æ%˜Æ<> Returns the left flags, but with all the right flags toggled.Áü§ÆA+õÆöÆýÆ8þ4÷Æ8‹Ç8ð4ŽÇ”ǦÇ8$•Ç$™Ç8î,›Ç& Ç8$¢Ç(¨Ç8$«Ç°ÇôÇ8$ÂÇÇÇæÇ8¥_$ÉÇ&ÍÇ8$ÏÇÓÇ8¥_$ÔÇÙÇ8î,ÛÇàÇ8¥_$áÇ8$‰È,ŽÈ8,�È'”È8é,–È'›È8Þ�È' È8BitXorAssignÁd¢È8
¯È,³È8ÁYD´È½ÈõÉ< Toggles the set of flags.ÁìËÈ+õÈöÈýÈ8þ4÷È8‹É8ñlŽÉ›É²ÉœÉ8�É8$¡É$¥É8î,§É&¬É8$®É´ÉëÉ8$ÆÉÊÉ8¥_$ËÉÐÉ8î,ÓÉØÉ8¥_$ÙÉ%ÝÉ8$€Ê,…Ê8,†Ê'‹Ê8é,�Ê'’Ê8Þ”Ê'—Ê8BitAndÁ4™Ê8
Ê,¤Ê8ÁYD¥Ê®Ê®Ì8!$¼Ê8Ø4ÁÊÈÊ8$ÊÊ%ÎÊ<8 Returns the intersection between the two sets of flags.ÁüÝÊ;+¥Ë¦ËË8þ4§Ë8»Ë8ë4¾ËÄËÖË8$ÅË$ÉË8î,ËË&ÐË8$ÒË(ØË8$ÛËàˤÌ8$òË÷Ë–Ì8¥_$ùË&ýË8$ÿ˃Ì8¥_$„̉Ì8î,‹Ì�Ì8¥_$‘Ì8$¹Ì,¾Ì8,¿Ì'ÄÌ8é,ÆÌ'ËÌ8ÞÍÌ'ÐÌ8BitAndAssignÁdÒÌ8
ÛÎ,ßÎ8ÁYDàÎéÎäÐ8!$÷Î8Ø4ü΃Ï8$…Ï%‰Ï<5 Returns the set difference of the two sets of flags.Áü˜Ï8+ÝÏÞÏåÏ8þ4ßÏ8óÏ8»öÏùÏ‹Ð8$úÏ$þÏ8î,€Ð&…Ð8$‡Ð(�Ð8$�ЕÐÚÐ8$§Ð¬ÐÌÐ
’Ñ,–Ñ8ÁYD—Ñ ÑãÒ<' Disables all flags enabled in the set.Áü®Ñ*+åÑæÑíÑ8þ4çÑ8ûÑ8¼Tþшҟ҉Ò8ŠÒ8$ŽÒ$’Ò8î,”Ò&™Ò8$›Ò¡ÒÙÒ8$³Ò·Ò8¥_$¸Ò½ÒÀÒ8î,ÁÒÆÒ8¥_$ÇÒ%ËÒ8$îÒ,óÒ8,ôÒ'ùÒ8é,ûÒ'€Ó8Þ‚Ó'…Ó8NotÁ‡Ó8
