15 lines
5.9 KiB
HTML
15 lines
5.9 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="Parsing flags from text."><title>bitflags::parser - Rust</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="../sidebar-items.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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module parser</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bitflags/index.html">bitflags</a><span class="version">2.11.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module parser</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bitflags</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">bitflags</a></div><h1>Module <span>parser</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bitflags/parser.rs.html#1-332">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsing flags from text.</p>
|
|
<p>Format and parse a flags value as text using the following grammar:</p>
|
|
<ul>
|
|
<li><em>Flags:</em> (<em>Whitespace</em> <em>Flag</em> <em>Whitespace</em>)<code>|</code>*</li>
|
|
<li><em>Flag:</em> <em>Name</em> | <em>Hex Number</em></li>
|
|
<li><em>Name:</em> The name of any defined flag</li>
|
|
<li><em>Hex Number</em>: <code>0x</code>([0-9a-fA-F])*</li>
|
|
<li><em>Whitespace</em>: (\s)*</li>
|
|
</ul>
|
|
<p>As an example, this is how <code>Flags::A | Flags::B | 0x0c</code> can be represented as text:</p>
|
|
<div class="example-wrap"><pre class="language-text"><code>A | B | 0x0c</code></pre></div>
|
|
<p>Alternatively, it could be represented without whitespace:</p>
|
|
<div class="example-wrap"><pre class="language-text"><code>A|B|0x0C</code></pre></div>
|
|
<p>Note that identifiers are <em>case-sensitive</em>, so the following is <em>not equivalent</em>:</p>
|
|
<div class="example-wrap"><pre class="language-text"><code>a|b|0x0C</code></pre></div></div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ParseError.html" title="struct bitflags::parser::ParseError">Parse<wbr>Error</a></dt><dd>An error encountered while parsing flags from text.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ParseHex.html" title="trait bitflags::parser::ParseHex">Parse<wbr>Hex</a></dt><dd>Parse a value from a hex string.</dd><dt><a class="trait" href="trait.WriteHex.html" title="trait bitflags::parser::WriteHex">Write<wbr>Hex</a></dt><dd>Encode a value as a hex string.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.from_str.html" title="fn bitflags::parser::from_str">from_<wbr>str</a></dt><dd>Parse a flags value from text.</dd><dt><a class="fn" href="fn.from_str_strict.html" title="fn bitflags::parser::from_str_strict">from_<wbr>str_<wbr>strict</a></dt><dd>Parse a flags value from text.</dd><dt><a class="fn" href="fn.from_str_truncate.html" title="fn bitflags::parser::from_str_truncate">from_<wbr>str_<wbr>truncate</a></dt><dd>Parse a flags value from text.</dd><dt><a class="fn" href="fn.to_writer.html" title="fn bitflags::parser::to_writer">to_<wbr>writer</a></dt><dd>Write a flags value as text.</dd><dt><a class="fn" href="fn.to_writer_strict.html" title="fn bitflags::parser::to_writer_strict">to_<wbr>writer_<wbr>strict</a></dt><dd>Write only the contained, defined, named flags in a flags value as text.</dd><dt><a class="fn" href="fn.to_writer_truncate.html" title="fn bitflags::parser::to_writer_truncate">to_<wbr>writer_<wbr>truncate</a></dt><dd>Write a flags value as text, ignoring any unknown bits.</dd></dl></section></div></main></body></html> |