|
|
<!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 `num_derive` crate."><meta name="keywords" content="rust, rustlang, rust-lang, num_derive"><title>num_derive - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../num_derive/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate num_derive</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all num_derive's items</p></a><p class='location'></p><script>window.sidebarCurrent = {name: 'num_derive', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/num_derive/lib.rs.html#11-797' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>num_derive</a></span></h1><div class='docblock'><p>Procedural macros to derive numeric traits in Rust.</p>
|
|
|
<h2 id="usage" class="section-header"><a href="#usage">Usage</a></h2>
|
|
|
<p>Add this to your <code>Cargo.toml</code>:</p>
|
|
|
<pre><code class="language-toml">[dependencies]
|
|
|
num-traits = "0.2"
|
|
|
num-derive = "0.2"
|
|
|
</code></pre>
|
|
|
<p>Then you can derive traits on your own types:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_derive</span>;
|
|
|
|
|
|
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">FromPrimitive</span>, <span class="ident">ToPrimitive</span>)]</span>
|
|
|
<span class="kw">enum</span> <span class="ident">Color</span> {
|
|
|
<span class="ident">Red</span>,
|
|
|
<span class="ident">Blue</span>,
|
|
|
<span class="ident">Green</span>,
|
|
|
}</pre></div>
|
|
|
</div><h2 id='derives' class='section-header'><a href="#derives">Derive Macros</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="derive" href="derive.Float.html" title='num_derive::Float derive'>Float</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/float/trait.Float.html"><code>num_traits::Float</code></a> for newtypes. The inner type must already implement
|
|
|
<code>Float</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.FromPrimitive.html" title='num_derive::FromPrimitive derive'>FromPrimitive</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/cast/trait.FromPrimitive.html"><code>num_traits::FromPrimitive</code></a> for simple enums and newtypes.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.Num.html" title='num_derive::Num derive'>Num</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/trait.Num.html"><code>num_traits::Num</code></a> for newtypes. The inner type must already implement <code>Num</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.NumCast.html" title='num_derive::NumCast derive'>NumCast</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/cast/trait.NumCast.html"><code>num_traits::NumCast</code></a> for newtypes. The inner type must already implement
|
|
|
<code>NumCast</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.NumOps.html" title='num_derive::NumOps derive'>NumOps</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/trait.NumOps.html"><code>num_traits::NumOps</code></a> for newtypes. The inner type must already implement
|
|
|
<code>NumOps</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.One.html" title='num_derive::One derive'>One</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/identities/trait.One.html"><code>num_traits::One</code></a> for newtypes. The inner type must already implement <code>One</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.ToPrimitive.html" title='num_derive::ToPrimitive derive'>ToPrimitive</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/cast/trait.ToPrimitive.html"><code>num_traits::ToPrimitive</code></a> for simple enums and newtypes.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="derive" href="derive.Zero.html" title='num_derive::Zero derive'>Zero</a></td><td class='docblock-short'><p>Derives <a href="https://docs.rs/num-traits/0.2/num_traits/identities/trait.Zero.html"><code>num_traits::Zero</code></a> for newtypes. The inner type must already implement <code>Zero</code>.</p>
|
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "num_derive";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
