sascha
/
difftastic
mirror of https://github.com/Wilfred/difftastic/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
difftastic/rustdoc/bitflags/parser/index.html

19 lines
7.3 KiB
HTML
Raw Permalink Blame History Unescape Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bitflags/index.html">bitflags</a><span class="version">2.5.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"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../bitflags/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><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"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="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>&#x2212;</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"><a href="#structs">Structs</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"><a href="#traits">Traits</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"><a href="#functions">Functions</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>
Reference in New Issue View Git Blame Copy Permalink