126 lines
17 KiB
HTML
126 lines
17 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/bitflags-2.11.0/src/internal.rs`."><title>internal.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bitflags" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">bitflags/</div>internal.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Generate the internal `bitflags`-facing flags type.
|
|
<a href=#2 id=2 data-nosnippet>2</a>//!
|
|
<a href=#3 id=3 data-nosnippet>3</a>//! The code generated here is owned by `bitflags`, but still part of its public API.
|
|
<a href=#4 id=4 data-nosnippet>4</a>//! Changes to the types generated here need to be considered like any other public API change.
|
|
<a href=#5 id=5 data-nosnippet>5</a>
|
|
<a href=#6 id=6 data-nosnippet>6</a>/// Declare the `bitflags`-facing bitflags struct.
|
|
<a href=#7 id=7 data-nosnippet>7</a>///
|
|
<a href=#8 id=8 data-nosnippet>8</a>/// This type is part of the `bitflags` crate's public API, but not part of the user's.
|
|
<a href=#9 id=9 data-nosnippet>9</a></span><span class="attr">#[macro_export]
|
|
<a href=#10 id=10 data-nosnippet>10</a>#[doc(hidden)]
|
|
<a href=#11 id=11 data-nosnippet>11</a></span><span class="macro">macro_rules!</span> __declare_internal_bitflags {
|
|
<a href=#12 id=12 data-nosnippet>12</a> (
|
|
<a href=#13 id=13 data-nosnippet>13</a> <span class="macro-nonterminal">$vis</span>:vis <span class="kw">struct </span><span class="macro-nonterminal">$InternalBitFlags</span>:ident: <span class="macro-nonterminal">$T</span>:ty
|
|
<a href=#14 id=14 data-nosnippet>14</a> ) => {
|
|
<a href=#15 id=15 data-nosnippet>15</a> <span class="comment">// NOTE: The ABI of this type is _guaranteed_ to be the same as `T`
|
|
<a href=#16 id=16 data-nosnippet>16</a> // This is relied on by some external libraries like `bytemuck` to make
|
|
<a href=#17 id=17 data-nosnippet>17</a> // its `unsafe` trait impls sound.
|
|
<a href=#18 id=18 data-nosnippet>18</a> </span><span class="attr">#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
<a href=#19 id=19 data-nosnippet>19</a> #[repr(transparent)]
|
|
<a href=#20 id=20 data-nosnippet>20</a> </span><span class="macro-nonterminal">$vis </span><span class="kw">struct </span><span class="macro-nonterminal">$InternalBitFlags</span>(<span class="macro-nonterminal">$T</span>);
|
|
<a href=#21 id=21 data-nosnippet>21</a> };
|
|
<a href=#22 id=22 data-nosnippet>22</a>}
|
|
<a href=#23 id=23 data-nosnippet>23</a>
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="doccomment">/// Implement functions on the private (bitflags-facing) bitflags type.
|
|
<a href=#25 id=25 data-nosnippet>25</a>///
|
|
<a href=#26 id=26 data-nosnippet>26</a>/// Methods and trait implementations can be freely added here without breaking end-users.
|
|
<a href=#27 id=27 data-nosnippet>27</a>/// If we want to expose new functionality to `#[derive]`, this is the place to do it.
|
|
<a href=#28 id=28 data-nosnippet>28</a></span><span class="attr">#[macro_export]
|
|
<a href=#29 id=29 data-nosnippet>29</a>#[doc(hidden)]
|
|
<a href=#30 id=30 data-nosnippet>30</a></span><span class="macro">macro_rules!</span> __impl_internal_bitflags {
|
|
<a href=#31 id=31 data-nosnippet>31</a> (
|
|
<a href=#32 id=32 data-nosnippet>32</a> <span class="macro-nonterminal">$InternalBitFlags</span>:ident: <span class="macro-nonterminal">$T</span>:ty, <span class="macro-nonterminal">$PublicBitFlags</span>:ident {
|
|
<a href=#33 id=33 data-nosnippet>33</a> $(
|
|
<a href=#34 id=34 data-nosnippet>34</a> $(<span class="attr">#[<span class="macro-nonterminal">$inner</span>:ident $(<span class="macro-nonterminal">$args</span>:tt)<span class="kw-2">*</span>]</span>)*
|
|
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">const </span><span class="macro-nonterminal">$Flag</span>:tt = <span class="macro-nonterminal">$value</span>:expr;
|
|
<a href=#36 id=36 data-nosnippet>36</a> )*
|
|
<a href=#37 id=37 data-nosnippet>37</a> }
|
|
<a href=#38 id=38 data-nosnippet>38</a> ) => {
|
|
<a href=#39 id=39 data-nosnippet>39</a> <span class="comment">// NOTE: This impl is also used to prevent using bits types from non-primitive types
|
|
<a href=#40 id=40 data-nosnippet>40</a> // in the `bitflags` macro. If this approach is changed, this guard will need to be
|
|
<a href=#41 id=41 data-nosnippet>41</a> // retained somehow
|
|
<a href=#42 id=42 data-nosnippet>42</a> </span><span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::PublicFlags </span><span class="kw">for </span><span class="macro-nonterminal">$PublicBitFlags </span>{
|
|
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">type </span>Primitive = <span class="macro-nonterminal">$T</span>;
|
|
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">type </span>Internal = <span class="macro-nonterminal">$InternalBitFlags</span>;
|
|
<a href=#45 id=45 data-nosnippet>45</a> }
|
|
<a href=#46 id=46 data-nosnippet>46</a>
|
|
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::core::default::Default </span><span class="kw">for </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#48 id=48 data-nosnippet>48</a> <span class="attr">#[inline]
|
|
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
|
<a href=#50 id=50 data-nosnippet>50</a> <span class="macro-nonterminal">$InternalBitFlags::empty</span>()
|
|
<a href=#51 id=51 data-nosnippet>51</a> }
|
|
<a href=#52 id=52 data-nosnippet>52</a> }
|
|
<a href=#53 id=53 data-nosnippet>53</a>
|
|
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::core::fmt::Debug </span><span class="kw">for </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span><span class="macro-nonterminal">$crate::__private::core::fmt::Formatter</span><<span class="lifetime">'_</span>>) -> <span class="macro-nonterminal">$crate::__private::core::fmt::Result </span>{
|
|
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">if </span><span class="self">self</span>.is_empty() {
|
|
<a href=#57 id=57 data-nosnippet>57</a> <span class="comment">// If no flags are set then write an empty hex flag to avoid
|
|
<a href=#58 id=58 data-nosnippet>58</a> // writing an empty string. In some contexts, like serialization,
|
|
<a href=#59 id=59 data-nosnippet>59</a> // an empty string is preferable, but it may be unexpected in
|
|
<a href=#60 id=60 data-nosnippet>60</a> // others for a format not to produce any output.
|
|
<a href=#61 id=61 data-nosnippet>61</a> //
|
|
<a href=#62 id=62 data-nosnippet>62</a> // We can remove this `0x0` and remain compatible with `FromStr`,
|
|
<a href=#63 id=63 data-nosnippet>63</a> // because an empty string will still parse to an empty set of flags,
|
|
<a href=#64 id=64 data-nosnippet>64</a> // just like `0x0` does.
|
|
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="macro-nonterminal">$crate::__private::core::write</span>!(f, <span class="string">"{:#x}"</span>, <<span class="macro-nonterminal">$T </span><span class="kw">as </span><span class="macro-nonterminal">$crate::Bits</span>>::EMPTY)
|
|
<a href=#66 id=66 data-nosnippet>66</a> } <span class="kw">else </span>{
|
|
<a href=#67 id=67 data-nosnippet>67</a> <span class="macro-nonterminal">$crate::__private::core::fmt::Display::fmt</span>(<span class="self">self</span>, f)
|
|
<a href=#68 id=68 data-nosnippet>68</a> }
|
|
<a href=#69 id=69 data-nosnippet>69</a> }
|
|
<a href=#70 id=70 data-nosnippet>70</a> }
|
|
<a href=#71 id=71 data-nosnippet>71</a>
|
|
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::core::fmt::Display </span><span class="kw">for </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span><span class="macro-nonterminal">$crate::__private::core::fmt::Formatter</span><<span class="lifetime">'_</span>>) -> <span class="macro-nonterminal">$crate::__private::core::fmt::Result </span>{
|
|
<a href=#74 id=74 data-nosnippet>74</a> <span class="macro-nonterminal">$crate::parser::to_writer</span>(<span class="kw-2">&</span><span class="macro-nonterminal">$PublicBitFlags</span>(<span class="kw-2">*</span><span class="self">self</span>), f)
|
|
<a href=#75 id=75 data-nosnippet>75</a> }
|
|
<a href=#76 id=76 data-nosnippet>76</a> }
|
|
<a href=#77 id=77 data-nosnippet>77</a>
|
|
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::core::str::FromStr </span><span class="kw">for </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">type </span><span class="prelude-val">Err </span>= <span class="macro-nonterminal">$crate::parser::ParseError</span>;
|
|
<a href=#80 id=80 data-nosnippet>80</a>
|
|
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">fn </span>from_str(s: <span class="kw-2">&</span>str) -> <span class="macro-nonterminal">$crate::__private::core::result::Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Err> {
|
|
<a href=#82 id=82 data-nosnippet>82</a> <span class="macro-nonterminal">$crate::parser::from_str</span>::<<span class="macro-nonterminal">$PublicBitFlags</span>>(s).map(|flags| flags.<span class="number">0</span>)
|
|
<a href=#83 id=83 data-nosnippet>83</a> }
|
|
<a href=#84 id=84 data-nosnippet>84</a> }
|
|
<a href=#85 id=85 data-nosnippet>85</a>
|
|
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::core::convert::AsRef</span><<span class="macro-nonterminal">$T</span>> <span class="kw">for </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="macro-nonterminal">$T </span>{
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0
|
|
<a href=#89 id=89 data-nosnippet>89</a> </span>}
|
|
<a href=#90 id=90 data-nosnippet>90</a> }
|
|
<a href=#91 id=91 data-nosnippet>91</a>
|
|
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::__private::core::convert::From</span><<span class="macro-nonterminal">$T</span>> <span class="kw">for </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">fn </span>from(bits: <span class="macro-nonterminal">$T</span>) -> <span class="self">Self </span>{
|
|
<a href=#94 id=94 data-nosnippet>94</a> <span class="self">Self</span>::from_bits_retain(bits)
|
|
<a href=#95 id=95 data-nosnippet>95</a> }
|
|
<a href=#96 id=96 data-nosnippet>96</a> }
|
|
<a href=#97 id=97 data-nosnippet>97</a>
|
|
<a href=#98 id=98 data-nosnippet>98</a> <span class="comment">// The internal flags type offers a similar API to the public one
|
|
<a href=#99 id=99 data-nosnippet>99</a>
|
|
<a href=#100 id=100 data-nosnippet>100</a> </span><span class="macro-nonterminal">$crate::__impl_public_bitflags</span>! {
|
|
<a href=#101 id=101 data-nosnippet>101</a> <span class="macro-nonterminal">$InternalBitFlags</span>: <span class="macro-nonterminal">$T</span>, <span class="macro-nonterminal">$PublicBitFlags </span>{
|
|
<a href=#102 id=102 data-nosnippet>102</a> $(
|
|
<a href=#103 id=103 data-nosnippet>103</a> $(<span class="attr">#[<span class="macro-nonterminal">$inner </span>$(<span class="macro-nonterminal">$args</span>)<span class="kw-2">*</span>]</span>)*
|
|
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">const </span><span class="macro-nonterminal">$Flag </span>= <span class="macro-nonterminal">$value</span>;
|
|
<a href=#105 id=105 data-nosnippet>105</a> )*
|
|
<a href=#106 id=106 data-nosnippet>106</a> }
|
|
<a href=#107 id=107 data-nosnippet>107</a> }
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a> <span class="macro-nonterminal">$crate::__impl_public_bitflags_ops</span>! {
|
|
<a href=#110 id=110 data-nosnippet>110</a> <span class="macro-nonterminal">$InternalBitFlags
|
|
<a href=#111 id=111 data-nosnippet>111</a> </span>}
|
|
<a href=#112 id=112 data-nosnippet>112</a>
|
|
<a href=#113 id=113 data-nosnippet>113</a> <span class="macro-nonterminal">$crate::__impl_public_bitflags_iter</span>! {
|
|
<a href=#114 id=114 data-nosnippet>114</a> <span class="macro-nonterminal">$InternalBitFlags</span>: <span class="macro-nonterminal">$T</span>, <span class="macro-nonterminal">$PublicBitFlags
|
|
<a href=#115 id=115 data-nosnippet>115</a> </span>}
|
|
<a href=#116 id=116 data-nosnippet>116</a>
|
|
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">impl </span><span class="macro-nonterminal">$InternalBitFlags </span>{
|
|
<a href=#118 id=118 data-nosnippet>118</a> <span class="doccomment">/// Returns a mutable reference to the raw value of the flags currently stored.
|
|
<a href=#119 id=119 data-nosnippet>119</a> </span><span class="attr">#[inline]
|
|
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">pub fn </span>bits_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span><span class="macro-nonterminal">$T </span>{
|
|
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw-2">&mut </span><span class="self">self</span>.<span class="number">0
|
|
<a href=#122 id=122 data-nosnippet>122</a> </span>}
|
|
<a href=#123 id=123 data-nosnippet>123</a> }
|
|
<a href=#124 id=124 data-nosnippet>124</a> };
|
|
<a href=#125 id=125 data-nosnippet>125</a>}
|
|
</code></pre></div></section></main></body></html> |