Skip to content

Commit

Permalink
deploy: 7ef216d
Browse files Browse the repository at this point in the history
  • Loading branch information
@GrayJack
GrayJack committed Nov 20, 2024
0 parents commit d65cc5e
Show file tree
Hide file tree
Showing 769 changed files with 90,585 additions and 0 deletions.
Empty file added .lock
Empty file.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions bitflag_attr/all.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bitflag_attr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0-nightly (ee612c45f 2024-11-19)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[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="../bitflag_attr/index.html">bitflag_<wbr>attr</a><span class="version">0.7.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate 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="#attributes" title="Attribute Macros">Attribute Macros</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="example_generated/struct.Flags.html">example_generated::Flags</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.BitflagPrimitive.html">BitflagPrimitive</a></li></ul><h3 id="attributes">Attribute Macros</h3><ul class="all-items"><li><a href="attr.bitflag.html">bitflag</a></li></ul></section></div></main></body></html>
64 changes: 64 additions & 0 deletions bitflag_attr/attr.bitflag.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!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="An attribute macro that transforms an C-like enum into a bitflag struct implementing an type API similar to the `bitflags` crate, and implementing traits as listed below."><title>bitflag in bitflag_attr - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bitflag_attr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0-nightly (ee612c45f 2024-11-19)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc attr"><!--[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="../bitflag_attr/index.html">bitflag_<wbr>attr</a><span class="version">0.7.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">bitflag</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#generated-trait-implementations" title="Generated trait implementations">Generated trait implementations</a><ul><li><a href="#serde-feature" title="Serde feature">Serde feature</a></li><li><a href="#custom-types" title="Custom types">Custom types</a></li></ul></li><li><a href="#example" title="Example">Example</a></li><li><a href="#syntax" title="Syntax">Syntax</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bitflag_<wbr>attr</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">bitflag_attr</a></span><h1>Attribute Macro <span class="attr">bitflag</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_attr_macros/lib.rs.html#105">Source</a> </span></div><pre class="rust item-decl"><code>#[bitflag]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An attribute macro that transforms an C-like enum into a bitflag struct implementing an type API
similar to the <code>bitflags</code> crate, and implementing traits as listed below.</p>
<h2 id="generated-trait-implementations"><a class="doc-anchor" href="#generated-trait-implementations">§</a>Generated trait implementations</h2>
<p>This macro generates some trait implementations: <a href="core::fmt::Debug"><code>fmt::Debug</code></a>, <a href="core::ops::Not"><code>ops:Not</code></a>, <a href="core::ops::BitAnd"><code>ops:BitAnd</code></a>,
<a href="core::ops::BitOr"><code>ops:BitOr</code></a>, <a href="core::ops::BitXor"><code>ops:BitXor</code></a>, <a href="core::ops::BitAndAssign"><code>ops:BitAndAssign</code></a>, <a href="core::ops::BitOrAssign"><code>ops:BitOrAssign</code></a>, <a href="core::ops::BitXorAssign"><code>ops:BitXorAssign</code></a>,
<a href="core::fmt::Binary"><code>fmt::Binary</code></a>, <a href="core::fmt::LowerHex"><code>fmt::LowerHex</code></a>, <a href="core::fmt::UpperHex"><code>fmt::UpperHex</code></a>, <a href="core::fmt::Octal"><code>fmt::Octal</code></a>, <a href="From"><code>From</code></a>, [<code>Clone</code>],
[<code>Copy</code>], [<code>Extend</code>], [<code>FromIterator</code>], [<code>IntoIterator</code>]</p>
<p>If the macro receives <code>no_auto_debug</code>, the trait <a href="core::fmt::Debug"><code>fmt::Debug</code></a> will not be generated. Use this
flag when you want to implement <a href="core::fmt::Debug"><code>fmt::Debug</code></a> manually or use the standard derive.</p>
<h3 id="serde-feature"><a class="doc-anchor" href="#serde-feature">§</a>Serde feature</h3>
<p>If the crate is compiled with the <code>serde</code> feature, this crate will generate implementations for
the <code>serde::{Serialize, Deserialize}</code> traits, but it will not import/re-export these traits,
your project must have <code>serde</code> as dependency.</p>
<p>Having this feature enabled will also generate a type to represent the parsing error and helper
functions to do parsing the generated type from strings. And will generate the implementation
for the <a href="core::str::FromStr"><code>FromStr</code></a> trait.</p>
<h3 id="custom-types"><a class="doc-anchor" href="#custom-types">§</a>Custom types</h3>
<p>If the crate is compiled with the <code>custom-types</code> feature, it allows to use more than the types
defined in Rust <code>core</code> (“i8”,<code>u8</code>,<code>i16</code>,<code>u16</code>,<code>i32</code>,<code>u32</code>,<code>i64</code>,<code>u64</code>,<code>i128</code>,<code>u128</code>,<code>isize</code>,
<code>usize</code>,<code>c_char</code>,<code>c_schar</code>,<code>c_uchar</code>,<code>c_short</code>,<code>c_ushort</code>,<code>c_int</code>,<code>c_uint</code>,<code>c_long</code>,<code>c_ulong</code>,
<code>c_longlong</code>,<code>c_ulonglong</code>) as long as it is a type alias to one of those types.</p>
<p>The reason it is behind a feature flag is that to ensure the validity of such constrain, we have
to pay the price of having much worse error messages. With this feature enabled, a invalid type
will cause a massive wall of error message.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bitflag_attr::bitflag;

<span class="attr">#[bitflag(u32)]
#[derive(PartialEq, PartialOrd, Eq, Ord, Hash)]
</span><span class="kw">pub enum </span>Flags {
<span class="doccomment">/// The value `A`, at bit position `0`.
</span>A = <span class="number">0b00000001</span>,
<span class="doccomment">/// The value `B`, at bit position `1`.
</span>B = <span class="number">0b00000010</span>,
<span class="doccomment">/// The value `C`, at bit position `2`.
</span>C = <span class="number">0b00000100</span>,

<span class="doccomment">/// The combination of `A`, `B`, and `C`.
</span>ABC = A | B | C,
}</code></pre></div>
<p>Without generating <a href="core::fmt::Debug"><code>fmt::Debug</code></a>:</p>

<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bitflag_attr::bitflag;

<span class="attr">#[bitflag(u32, no_auto_debug)]
#[derive(PartialEq, PartialOrd, Eq, Ord, Hash)]
</span><span class="kw">pub enum </span>Flags {
<span class="doccomment">/// The value `A`, at bit position `0`.
</span>A = <span class="number">0b00000001</span>,
<span class="doccomment">/// The value `B`, at bit position `1`.
</span>B = <span class="number">0b00000010</span>,
<span class="doccomment">/// The value `C`, at bit position `2`.
</span>C = <span class="number">0b00000100</span>,

<span class="doccomment">/// The combination of `A`, `B`, and `C`.
</span>ABC = A | B | C,
}</code></pre></div>
<h2 id="syntax"><a class="doc-anchor" href="#syntax">§</a>Syntax</h2><div class="example-wrap"><pre class="language-text"><code>#[bitflag($ty[, no_auto_debug])]
$visibility enum $StructName {
FlagOne = flag1_value_expr,
FlagTwo = flag2_value_expr,
// ...
FlagN = flagn_value_expr,
}</code></pre></div></div></details></section></div></main></body></html>
1 change: 1 addition & 0 deletions bitflag_attr/example_generated/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!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="API documentation for the Rust `example_generated` mod in crate `bitflag_attr`."><title>bitflag_attr::example_generated - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bitflag_attr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0-nightly (ee612c45f 2024-11-19)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bitflag_attr/index.html">bitflag_<wbr>attr</a><span class="version">0.7.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module example_<wbr>generated</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bitflag_<wbr>attr</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">bitflag_attr</a></span><h1>Module <span>example_generated</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/bitflag_attr/example_generated.rs.html#1-388">Source</a> </span></div><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.Flags.html" title="struct bitflag_attr::example_generated::Flags">Flags</a></div></li></ul></section></div></main></body></html>
1 change: 1 addition & 0 deletions bitflag_attr/example_generated/sidebar-items.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["Flags"]};
Loading

0 comments on commit d65cc5e

Please sign in to comment.