Adding large folders

This commit is contained in:
2026-02-26 12:00:21 -05:00
parent 5400d82acd
commit 49701c85ad
47332 changed files with 1942573 additions and 0 deletions

View File

@@ -0,0 +1,333 @@
<!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/parser.rs`."><title>parser.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>parser.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">/*!
<a href=#2 id=2 data-nosnippet>2</a>Parsing flags from text.
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a>Format and parse a flags value as text using the following grammar:
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a>- _Flags:_ (_Whitespace_ _Flag_ _Whitespace_)`|`*
<a href=#7 id=7 data-nosnippet>7</a>- _Flag:_ _Name_ | _Hex Number_
<a href=#8 id=8 data-nosnippet>8</a>- _Name:_ The name of any defined flag
<a href=#9 id=9 data-nosnippet>9</a>- _Hex Number_: `0x`([0-9a-fA-F])*
<a href=#10 id=10 data-nosnippet>10</a>- _Whitespace_: (\s)*
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a>As an example, this is how `Flags::A | Flags::B | 0x0c` can be represented as text:
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a>```text
<a href=#15 id=15 data-nosnippet>15</a>A | B | 0x0c
<a href=#16 id=16 data-nosnippet>16</a>```
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a>Alternatively, it could be represented without whitespace:
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a>```text
<a href=#21 id=21 data-nosnippet>21</a>A|B|0x0C
<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>Note that identifiers are *case-sensitive*, so the following is *not equivalent*:
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a>```text
<a href=#27 id=27 data-nosnippet>27</a>a|b|0x0C
<a href=#28 id=28 data-nosnippet>28</a>```
<a href=#29 id=29 data-nosnippet>29</a>*/
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a></span><span class="attr">#![allow(clippy::let_unit_value)]
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">use </span>core::fmt::{<span class="self">self</span>, Write};
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="kw">use crate</span>::{Bits, Flags};
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a><span class="doccomment">/**
<a href=#38 id=38 data-nosnippet>38</a>Write a flags value as text.
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a>Any bits that aren't part of a contained flag will be formatted as a hex number.
<a href=#41 id=41 data-nosnippet>41</a>*/
<a href=#42 id=42 data-nosnippet>42</a></span><span class="kw">pub fn </span>to_writer&lt;B: Flags&gt;(flags: <span class="kw-2">&amp;</span>B, <span class="kw-2">mut </span>writer: <span class="kw">impl </span>Write) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt;
<a href=#43 id=43 data-nosnippet>43</a><span class="kw">where
<a href=#44 id=44 data-nosnippet>44</a> </span>B::Bits: WriteHex,
<a href=#45 id=45 data-nosnippet>45</a>{
<a href=#46 id=46 data-nosnippet>46</a> <span class="comment">// A formatter for bitflags that produces text output like:
<a href=#47 id=47 data-nosnippet>47</a> //
<a href=#48 id=48 data-nosnippet>48</a> // A | B | 0xf6
<a href=#49 id=49 data-nosnippet>49</a> //
<a href=#50 id=50 data-nosnippet>50</a> // The names of set flags are written in a bar-separated-format,
<a href=#51 id=51 data-nosnippet>51</a> // followed by a hex number of any remaining bits that are set
<a href=#52 id=52 data-nosnippet>52</a> // but don't correspond to any flags.
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a> // Iterate over known flag values
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">let </span><span class="kw-2">mut </span>first = <span class="bool-val">true</span>;
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span><span class="kw-2">mut </span>iter = flags.iter_names();
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">for </span>(name, <span class="kw">_</span>) <span class="kw">in </span><span class="kw-2">&amp;mut </span>iter {
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">if </span>!first {
<a href=#59 id=59 data-nosnippet>59</a> writer.write_str(<span class="string">" | "</span>)<span class="question-mark">?</span>;
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> first = <span class="bool-val">false</span>;
<a href=#63 id=63 data-nosnippet>63</a> writer.write_str(name)<span class="question-mark">?</span>;
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> <span class="comment">// Append any extra bits that correspond to flags to the end of the format
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">let </span>remaining = iter.remaining().bits();
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">if </span><span class="macro">remaining !</span>= B::Bits::EMPTY {
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">if </span>!first {
<a href=#70 id=70 data-nosnippet>70</a> writer.write_str(<span class="string">" | "</span>)<span class="question-mark">?</span>;
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> writer.write_str(<span class="string">"0x"</span>)<span class="question-mark">?</span>;
<a href=#74 id=74 data-nosnippet>74</a> remaining.write_hex(writer)<span class="question-mark">?</span>;
<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> fmt::Result::Ok(())
<a href=#78 id=78 data-nosnippet>78</a>}
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a><span class="attr">#[cfg(feature = <span class="string">"serde"</span>)]
<a href=#81 id=81 data-nosnippet>81</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>AsDisplay&lt;<span class="lifetime">'a</span>, B&gt;(<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw-2">&amp;</span><span class="lifetime">'a </span>B);
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a><span class="attr">#[cfg(feature = <span class="string">"serde"</span>)]
<a href=#84 id=84 data-nosnippet>84</a></span><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, B: Flags&gt; fmt::Display <span class="kw">for </span>AsDisplay&lt;<span class="lifetime">'a</span>, B&gt;
<a href=#85 id=85 data-nosnippet>85</a><span class="kw">where
<a href=#86 id=86 data-nosnippet>86</a> </span>B::Bits: WriteHex,
<a href=#87 id=87 data-nosnippet>87</a>{
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#89 id=89 data-nosnippet>89</a> to_writer(<span class="self">self</span>.<span class="number">0</span>, f)
<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>
<a href=#93 id=93 data-nosnippet>93</a><span class="doccomment">/**
<a href=#94 id=94 data-nosnippet>94</a>Parse a flags value from text.
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a>This function will fail on any names that don't correspond to defined flags.
<a href=#97 id=97 data-nosnippet>97</a>Unknown bits will be retained.
<a href=#98 id=98 data-nosnippet>98</a>*/
<a href=#99 id=99 data-nosnippet>99</a></span><span class="kw">pub fn </span>from_str&lt;B: Flags&gt;(input: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;B, ParseError&gt;
<a href=#100 id=100 data-nosnippet>100</a><span class="kw">where
<a href=#101 id=101 data-nosnippet>101</a> </span>B::Bits: ParseHex,
<a href=#102 id=102 data-nosnippet>102</a>{
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span><span class="kw-2">mut </span>parsed_flags = B::empty();
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="comment">// If the input is empty then return an empty set of flags
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">if </span>input.trim().is_empty() {
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(parsed_flags);
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">for </span>flag <span class="kw">in </span>input.split(<span class="string">'|'</span>) {
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">let </span>flag = flag.trim();
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="comment">// If the flag is empty then we've got missing input
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">if </span>flag.is_empty() {
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::empty_flag());
<a href=#116 id=116 data-nosnippet>116</a> }
<a href=#117 id=117 data-nosnippet>117</a>
<a href=#118 id=118 data-nosnippet>118</a> <span class="comment">// If the flag starts with `0x` then it's a hex number
<a href=#119 id=119 data-nosnippet>119</a> // Parse it directly to the underlying bits type
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">let </span>parsed_flag = <span class="kw">if let </span><span class="prelude-val">Some</span>(flag) = flag.strip_prefix(<span class="string">"0x"</span>) {
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">let </span>bits =
<a href=#122 id=122 data-nosnippet>122</a> &lt;B::Bits&gt;::parse_hex(flag).map_err(|<span class="kw">_</span>| ParseError::invalid_hex_flag(flag))<span class="question-mark">?</span>;
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> B::from_bits_retain(bits)
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a> <span class="comment">// Otherwise the flag is a name
<a href=#127 id=127 data-nosnippet>127</a> // The generated flags type will determine whether
<a href=#128 id=128 data-nosnippet>128</a> // or not it's a valid identifier
<a href=#129 id=129 data-nosnippet>129</a> </span><span class="kw">else </span>{
<a href=#130 id=130 data-nosnippet>130</a> B::from_name(flag).ok_or_else(|| ParseError::invalid_named_flag(flag))<span class="question-mark">?
<a href=#131 id=131 data-nosnippet>131</a> </span>};
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> parsed_flags.insert(parsed_flag);
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="prelude-val">Ok</span>(parsed_flags)
<a href=#137 id=137 data-nosnippet>137</a>}
<a href=#138 id=138 data-nosnippet>138</a>
<a href=#139 id=139 data-nosnippet>139</a><span class="doccomment">/**
<a href=#140 id=140 data-nosnippet>140</a>Write a flags value as text, ignoring any unknown bits.
<a href=#141 id=141 data-nosnippet>141</a>*/
<a href=#142 id=142 data-nosnippet>142</a></span><span class="kw">pub fn </span>to_writer_truncate&lt;B: Flags&gt;(flags: <span class="kw-2">&amp;</span>B, writer: <span class="kw">impl </span>Write) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt;
<a href=#143 id=143 data-nosnippet>143</a><span class="kw">where
<a href=#144 id=144 data-nosnippet>144</a> </span>B::Bits: WriteHex,
<a href=#145 id=145 data-nosnippet>145</a>{
<a href=#146 id=146 data-nosnippet>146</a> to_writer(<span class="kw-2">&amp;</span>B::from_bits_truncate(flags.bits()), writer)
<a href=#147 id=147 data-nosnippet>147</a>}
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a><span class="doccomment">/**
<a href=#150 id=150 data-nosnippet>150</a>Parse a flags value from text.
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a>This function will fail on any names that don't correspond to defined flags.
<a href=#153 id=153 data-nosnippet>153</a>Unknown bits will be ignored.
<a href=#154 id=154 data-nosnippet>154</a>*/
<a href=#155 id=155 data-nosnippet>155</a></span><span class="kw">pub fn </span>from_str_truncate&lt;B: Flags&gt;(input: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;B, ParseError&gt;
<a href=#156 id=156 data-nosnippet>156</a><span class="kw">where
<a href=#157 id=157 data-nosnippet>157</a> </span>B::Bits: ParseHex,
<a href=#158 id=158 data-nosnippet>158</a>{
<a href=#159 id=159 data-nosnippet>159</a> <span class="prelude-val">Ok</span>(B::from_bits_truncate(from_str::&lt;B&gt;(input)<span class="question-mark">?</span>.bits()))
<a href=#160 id=160 data-nosnippet>160</a>}
<a href=#161 id=161 data-nosnippet>161</a>
<a href=#162 id=162 data-nosnippet>162</a><span class="doccomment">/**
<a href=#163 id=163 data-nosnippet>163</a>Write only the contained, defined, named flags in a flags value as text.
<a href=#164 id=164 data-nosnippet>164</a>*/
<a href=#165 id=165 data-nosnippet>165</a></span><span class="kw">pub fn </span>to_writer_strict&lt;B: Flags&gt;(flags: <span class="kw-2">&amp;</span>B, <span class="kw-2">mut </span>writer: <span class="kw">impl </span>Write) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
<a href=#166 id=166 data-nosnippet>166</a> <span class="comment">// This is a simplified version of `to_writer` that ignores
<a href=#167 id=167 data-nosnippet>167</a> // any bits not corresponding to a named flag
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> </span><span class="kw">let </span><span class="kw-2">mut </span>first = <span class="bool-val">true</span>;
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span><span class="kw-2">mut </span>iter = flags.iter_names();
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">for </span>(name, <span class="kw">_</span>) <span class="kw">in </span><span class="kw-2">&amp;mut </span>iter {
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">if </span>!first {
<a href=#173 id=173 data-nosnippet>173</a> writer.write_str(<span class="string">" | "</span>)<span class="question-mark">?</span>;
<a href=#174 id=174 data-nosnippet>174</a> }
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> first = <span class="bool-val">false</span>;
<a href=#177 id=177 data-nosnippet>177</a> writer.write_str(name)<span class="question-mark">?</span>;
<a href=#178 id=178 data-nosnippet>178</a> }
<a href=#179 id=179 data-nosnippet>179</a>
<a href=#180 id=180 data-nosnippet>180</a> fmt::Result::Ok(())
<a href=#181 id=181 data-nosnippet>181</a>}
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a><span class="doccomment">/**
<a href=#184 id=184 data-nosnippet>184</a>Parse a flags value from text.
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a>This function will fail on any names that don't correspond to defined flags.
<a href=#187 id=187 data-nosnippet>187</a>This function will fail to parse hex values.
<a href=#188 id=188 data-nosnippet>188</a>*/
<a href=#189 id=189 data-nosnippet>189</a></span><span class="kw">pub fn </span>from_str_strict&lt;B: Flags&gt;(input: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;B, ParseError&gt; {
<a href=#190 id=190 data-nosnippet>190</a> <span class="comment">// This is a simplified version of `from_str` that ignores
<a href=#191 id=191 data-nosnippet>191</a> // any bits not corresponding to a named flag
<a href=#192 id=192 data-nosnippet>192</a>
<a href=#193 id=193 data-nosnippet>193</a> </span><span class="kw">let </span><span class="kw-2">mut </span>parsed_flags = B::empty();
<a href=#194 id=194 data-nosnippet>194</a>
<a href=#195 id=195 data-nosnippet>195</a> <span class="comment">// If the input is empty then return an empty set of flags
<a href=#196 id=196 data-nosnippet>196</a> </span><span class="kw">if </span>input.trim().is_empty() {
<a href=#197 id=197 data-nosnippet>197</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(parsed_flags);
<a href=#198 id=198 data-nosnippet>198</a> }
<a href=#199 id=199 data-nosnippet>199</a>
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">for </span>flag <span class="kw">in </span>input.split(<span class="string">'|'</span>) {
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">let </span>flag = flag.trim();
<a href=#202 id=202 data-nosnippet>202</a>
<a href=#203 id=203 data-nosnippet>203</a> <span class="comment">// If the flag is empty then we've got missing input
<a href=#204 id=204 data-nosnippet>204</a> </span><span class="kw">if </span>flag.is_empty() {
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::empty_flag());
<a href=#206 id=206 data-nosnippet>206</a> }
<a href=#207 id=207 data-nosnippet>207</a>
<a href=#208 id=208 data-nosnippet>208</a> <span class="comment">// If the flag starts with `0x` then it's a hex number
<a href=#209 id=209 data-nosnippet>209</a> // These aren't supported in the strict parser
<a href=#210 id=210 data-nosnippet>210</a> </span><span class="kw">if </span>flag.starts_with(<span class="string">"0x"</span>) {
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::invalid_hex_flag(<span class="string">"unsupported hex flag value"</span>));
<a href=#212 id=212 data-nosnippet>212</a> }
<a href=#213 id=213 data-nosnippet>213</a>
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">let </span>parsed_flag = B::from_name(flag).ok_or_else(|| ParseError::invalid_named_flag(flag))<span class="question-mark">?</span>;
<a href=#215 id=215 data-nosnippet>215</a>
<a href=#216 id=216 data-nosnippet>216</a> parsed_flags.insert(parsed_flag);
<a href=#217 id=217 data-nosnippet>217</a> }
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a> <span class="prelude-val">Ok</span>(parsed_flags)
<a href=#220 id=220 data-nosnippet>220</a>}
<a href=#221 id=221 data-nosnippet>221</a>
<a href=#222 id=222 data-nosnippet>222</a><span class="doccomment">/**
<a href=#223 id=223 data-nosnippet>223</a>Encode a value as a hex string.
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a>Implementors of this trait should not write the `0x` prefix.
<a href=#226 id=226 data-nosnippet>226</a>*/
<a href=#227 id=227 data-nosnippet>227</a></span><span class="kw">pub trait </span>WriteHex {
<a href=#228 id=228 data-nosnippet>228</a> <span class="doccomment">/// Write the value as hex.
<a href=#229 id=229 data-nosnippet>229</a> </span><span class="kw">fn </span>write_hex&lt;W: fmt::Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: W) -&gt; fmt::Result;
<a href=#230 id=230 data-nosnippet>230</a>}
<a href=#231 id=231 data-nosnippet>231</a>
<a href=#232 id=232 data-nosnippet>232</a><span class="doccomment">/**
<a href=#233 id=233 data-nosnippet>233</a>Parse a value from a hex string.
<a href=#234 id=234 data-nosnippet>234</a>*/
<a href=#235 id=235 data-nosnippet>235</a></span><span class="kw">pub trait </span>ParseHex {
<a href=#236 id=236 data-nosnippet>236</a> <span class="doccomment">/// Parse the value from hex.
<a href=#237 id=237 data-nosnippet>237</a> </span><span class="kw">fn </span>parse_hex(input: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, ParseError&gt;
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">where
<a href=#239 id=239 data-nosnippet>239</a> </span><span class="self">Self</span>: Sized;
<a href=#240 id=240 data-nosnippet>240</a>}
<a href=#241 id=241 data-nosnippet>241</a>
<a href=#242 id=242 data-nosnippet>242</a><span class="doccomment">/// An error encountered while parsing flags from text.
<a href=#243 id=243 data-nosnippet>243</a></span><span class="attr">#[derive(Debug)]
<a href=#244 id=244 data-nosnippet>244</a></span><span class="kw">pub struct </span>ParseError(ParseErrorKind);
<a href=#245 id=245 data-nosnippet>245</a>
<a href=#246 id=246 data-nosnippet>246</a><span class="attr">#[derive(Debug)]
<a href=#247 id=247 data-nosnippet>247</a>#[allow(clippy::enum_variant_names)]
<a href=#248 id=248 data-nosnippet>248</a></span><span class="kw">enum </span>ParseErrorKind {
<a href=#249 id=249 data-nosnippet>249</a> EmptyFlag,
<a href=#250 id=250 data-nosnippet>250</a> InvalidNamedFlag {
<a href=#251 id=251 data-nosnippet>251</a> <span class="attr">#[cfg(not(feature = <span class="string">"std"</span>))]
<a href=#252 id=252 data-nosnippet>252</a> </span>got: (),
<a href=#253 id=253 data-nosnippet>253</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#254 id=254 data-nosnippet>254</a> </span>got: String,
<a href=#255 id=255 data-nosnippet>255</a> },
<a href=#256 id=256 data-nosnippet>256</a> InvalidHexFlag {
<a href=#257 id=257 data-nosnippet>257</a> <span class="attr">#[cfg(not(feature = <span class="string">"std"</span>))]
<a href=#258 id=258 data-nosnippet>258</a> </span>got: (),
<a href=#259 id=259 data-nosnippet>259</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#260 id=260 data-nosnippet>260</a> </span>got: String,
<a href=#261 id=261 data-nosnippet>261</a> },
<a href=#262 id=262 data-nosnippet>262</a>}
<a href=#263 id=263 data-nosnippet>263</a>
<a href=#264 id=264 data-nosnippet>264</a><span class="kw">impl </span>ParseError {
<a href=#265 id=265 data-nosnippet>265</a> <span class="doccomment">/// An invalid hex flag was encountered.
<a href=#266 id=266 data-nosnippet>266</a> </span><span class="kw">pub fn </span>invalid_hex_flag(flag: <span class="kw">impl </span>fmt::Display) -&gt; <span class="self">Self </span>{
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw">let </span>_flag = flag;
<a href=#268 id=268 data-nosnippet>268</a>
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">let </span>got = {
<a href=#270 id=270 data-nosnippet>270</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#271 id=271 data-nosnippet>271</a> </span>{
<a href=#272 id=272 data-nosnippet>272</a> _flag.to_string()
<a href=#273 id=273 data-nosnippet>273</a> }
<a href=#274 id=274 data-nosnippet>274</a> };
<a href=#275 id=275 data-nosnippet>275</a>
<a href=#276 id=276 data-nosnippet>276</a> ParseError(ParseErrorKind::InvalidHexFlag { got })
<a href=#277 id=277 data-nosnippet>277</a> }
<a href=#278 id=278 data-nosnippet>278</a>
<a href=#279 id=279 data-nosnippet>279</a> <span class="doccomment">/// A named flag that doesn't correspond to any on the flags type was encountered.
<a href=#280 id=280 data-nosnippet>280</a> </span><span class="kw">pub fn </span>invalid_named_flag(flag: <span class="kw">impl </span>fmt::Display) -&gt; <span class="self">Self </span>{
<a href=#281 id=281 data-nosnippet>281</a> <span class="kw">let </span>_flag = flag;
<a href=#282 id=282 data-nosnippet>282</a>
<a href=#283 id=283 data-nosnippet>283</a> <span class="kw">let </span>got = {
<a href=#284 id=284 data-nosnippet>284</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#285 id=285 data-nosnippet>285</a> </span>{
<a href=#286 id=286 data-nosnippet>286</a> _flag.to_string()
<a href=#287 id=287 data-nosnippet>287</a> }
<a href=#288 id=288 data-nosnippet>288</a> };
<a href=#289 id=289 data-nosnippet>289</a>
<a href=#290 id=290 data-nosnippet>290</a> ParseError(ParseErrorKind::InvalidNamedFlag { got })
<a href=#291 id=291 data-nosnippet>291</a> }
<a href=#292 id=292 data-nosnippet>292</a>
<a href=#293 id=293 data-nosnippet>293</a> <span class="doccomment">/// A hex or named flag wasn't found between separators.
<a href=#294 id=294 data-nosnippet>294</a> </span><span class="kw">pub const fn </span>empty_flag() -&gt; <span class="self">Self </span>{
<a href=#295 id=295 data-nosnippet>295</a> ParseError(ParseErrorKind::EmptyFlag)
<a href=#296 id=296 data-nosnippet>296</a> }
<a href=#297 id=297 data-nosnippet>297</a>}
<a href=#298 id=298 data-nosnippet>298</a>
<a href=#299 id=299 data-nosnippet>299</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>ParseError {
<a href=#300 id=300 data-nosnippet>300</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#301 id=301 data-nosnippet>301</a> <span class="kw">match </span><span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0 </span>{
<a href=#302 id=302 data-nosnippet>302</a> ParseErrorKind::InvalidNamedFlag { got } =&gt; {
<a href=#303 id=303 data-nosnippet>303</a> <span class="kw">let </span>_got = got;
<a href=#304 id=304 data-nosnippet>304</a>
<a href=#305 id=305 data-nosnippet>305</a> <span class="macro">write!</span>(f, <span class="string">"unrecognized named flag"</span>)<span class="question-mark">?</span>;
<a href=#306 id=306 data-nosnippet>306</a>
<a href=#307 id=307 data-nosnippet>307</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#308 id=308 data-nosnippet>308</a> </span>{
<a href=#309 id=309 data-nosnippet>309</a> <span class="macro">write!</span>(f, <span class="string">" `{}`"</span>, _got)<span class="question-mark">?</span>;
<a href=#310 id=310 data-nosnippet>310</a> }
<a href=#311 id=311 data-nosnippet>311</a> }
<a href=#312 id=312 data-nosnippet>312</a> ParseErrorKind::InvalidHexFlag { got } =&gt; {
<a href=#313 id=313 data-nosnippet>313</a> <span class="kw">let </span>_got = got;
<a href=#314 id=314 data-nosnippet>314</a>
<a href=#315 id=315 data-nosnippet>315</a> <span class="macro">write!</span>(f, <span class="string">"invalid hex flag"</span>)<span class="question-mark">?</span>;
<a href=#316 id=316 data-nosnippet>316</a>
<a href=#317 id=317 data-nosnippet>317</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#318 id=318 data-nosnippet>318</a> </span>{
<a href=#319 id=319 data-nosnippet>319</a> <span class="macro">write!</span>(f, <span class="string">" `{}`"</span>, _got)<span class="question-mark">?</span>;
<a href=#320 id=320 data-nosnippet>320</a> }
<a href=#321 id=321 data-nosnippet>321</a> }
<a href=#322 id=322 data-nosnippet>322</a> ParseErrorKind::EmptyFlag =&gt; {
<a href=#323 id=323 data-nosnippet>323</a> <span class="macro">write!</span>(f, <span class="string">"encountered empty flag"</span>)<span class="question-mark">?</span>;
<a href=#324 id=324 data-nosnippet>324</a> }
<a href=#325 id=325 data-nosnippet>325</a> }
<a href=#326 id=326 data-nosnippet>326</a>
<a href=#327 id=327 data-nosnippet>327</a> <span class="prelude-val">Ok</span>(())
<a href=#328 id=328 data-nosnippet>328</a> }
<a href=#329 id=329 data-nosnippet>329</a>}
<a href=#330 id=330 data-nosnippet>330</a>
<a href=#331 id=331 data-nosnippet>331</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#332 id=332 data-nosnippet>332</a></span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>ParseError {}
</code></pre></div></section></main></body></html>