mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-19 17:14:24 +00:00
18 lines
6.3 KiB
HTML
18 lines
6.3 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-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bitflags/index.html">bitflags</a><span class="version">2.6.0</span></h2></div><h2 class="location"><a href="#">Module parser</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate bitflags</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">bitflags</a>::<wbr><a class="mod" href="#">parser</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/bitflags/parser.rs.html#1-332">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ParseError.html" title="struct bitflags::parser::ParseError">ParseError</a></div><div class="desc docblock-short">An error encountered while parsing flags from text.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ParseHex.html" title="trait bitflags::parser::ParseHex">ParseHex</a></div><div class="desc docblock-short">Parse a value from a hex string.</div></li><li><div class="item-name"><a class="trait" href="trait.WriteHex.html" title="trait bitflags::parser::WriteHex">WriteHex</a></div><div class="desc docblock-short">Encode a value as a hex string.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.from_str.html" title="fn bitflags::parser::from_str">from_str</a></div><div class="desc docblock-short">Parse a flags value from text.</div></li><li><div class="item-name"><a class="fn" href="fn.from_str_strict.html" title="fn bitflags::parser::from_str_strict">from_str_strict</a></div><div class="desc docblock-short">Parse a flags value from text.</div></li><li><div class="item-name"><a class="fn" href="fn.from_str_truncate.html" title="fn bitflags::parser::from_str_truncate">from_str_truncate</a></div><div class="desc docblock-short">Parse a flags value from text.</div></li><li><div class="item-name"><a class="fn" href="fn.to_writer.html" title="fn bitflags::parser::to_writer">to_writer</a></div><div class="desc docblock-short">Write a flags value as text.</div></li><li><div class="item-name"><a class="fn" href="fn.to_writer_strict.html" title="fn bitflags::parser::to_writer_strict">to_writer_strict</a></div><div class="desc docblock-short">Write only the contained, defined, named flags in a flags value as text.</div></li><li><div class="item-name"><a class="fn" href="fn.to_writer_truncate.html" title="fn bitflags::parser::to_writer_truncate">to_writer_truncate</a></div><div class="desc docblock-short">Write a flags value as text, ignoring any unknown bits.</div></li></ul></section></div></main></body></html> |