github-actions[bot]
25 lines
19 KiB
HTML
25 lines
19 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="API documentation for the Rust `One` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, One"><title>num_traits::identities::One - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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_traits/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait One</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.one">one</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is_one">is_one</a><a href="#method.set_one">set_one</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-One-for-Wrapping%3CT%3E">Wrapping<T></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">num_traits</a>::<wbr><a href="index.html">identities</a></p><script>window.sidebarCurrent = {name: "One", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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_traits/identities.rs.html#90-118" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">num_traits</a>::<wbr><a href="index.html">identities</a>::<wbr><a class="trait" href="">One</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait One: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Self, Output = Self> {
|
||
fn <a href="#tymethod.one" class="fnname">one</a>() -> Self;
|
||
|
||
fn <a href="#method.set_one" class="fnname">set_one</a>(&mut self) { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.is_one" class="fnname">is_one</a>(&self) -> bool<br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a></span>,
|
||
{ ... }
|
||
}</pre></div><div class="docblock"><p>Defines a multiplicative identity element for <code>Self</code>.</p>
|
||
<h1 id="laws" class="section-header"><a href="#laws">Laws</a></h1>
|
||
<pre><code class="language-{.text}">a * 1 = a ∀ a ∈ Self
|
||
1 * a = a ∀ a ∈ Self
|
||
</code></pre>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.one" class="method"><code>fn <a href="#tymethod.one" class="fnname">one</a>() -> Self</code><a class="srclink" href="../../src/num_traits/identities.rs.html#99" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the multiplicative identity element of <code>Self</code>, <code>1</code>.</p>
|
||
<h1 id="purity" class="section-header"><a href="#purity">Purity</a></h1>
|
||
<p>This function should return the same result at all times regardless of
|
||
external mutable state, for example values stored in TLS or in
|
||
<code>static mut</code>s.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.set_one" class="method"><code>fn <a href="#method.set_one" class="fnname">set_one</a>(&mut self)</code><a class="srclink" href="../../src/num_traits/identities.rs.html#102-104" title="goto source code">[src]</a></h3><div class="docblock"><p>Sets <code>self</code> to the multiplicative identity element of <code>Self</code>, <code>1</code>.</p>
|
||
</div><h3 id="method.is_one" class="method"><code>fn <a href="#method.is_one" class="fnname">is_one</a>(&self) -> bool <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>, </span></code><a class="srclink" href="../../src/num_traits/identities.rs.html#112-117" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns <code>true</code> if <code>self</code> is equal to the multiplicative identity.</p>
|
||
<p>For performance reasons, it's best to implement this manually.
|
||
After a semver bump, this method will be required, and the
|
||
<code>where Self: PartialEq</code> bound will be removed.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-One-for-Wrapping%3CT%3E" class="impl"><code class="in-band">impl<T: <a class="trait" href="../../num_traits/identities/trait.One.html" title="trait num_traits::identities::One">One</a>> <a class="trait" href="../../num_traits/identities/trait.One.html" title="trait num_traits::identities::One">One</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T> <span class="where fmt-newline">where<br> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T>>, </span></code><a href="#impl-One-for-Wrapping%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#154-165" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.set_one-1" class="method hidden"><code>fn <a href="#method.set_one" class="fnname">set_one</a>(&mut self)</code><a class="srclink" href="../../src/num_traits/identities.rs.html#158-160" title="goto source code">[src]</a></h4><h4 id="method.one" class="method hidden"><code>fn <a href="#method.one" class="fnname">one</a>() -> Self</code><a class="srclink" href="../../src/num_traits/identities.rs.html#162-164" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-One" class="impl"><code class="in-band">impl One for f32</code><a href="#impl-One" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#151" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-1" class="method hidden"><code>fn <a href="#method.one-1" class="fnname">one</a>() -> f32</code><a class="srclink" href="../../src/num_traits/identities.rs.html#151" title="goto source code">[src]</a></h4><h4 id="method.is_one-1" class="method hidden"><code>fn <a href="#method.is_one-1" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#151" title="goto source code">[src]</a></h4></div><h3 id="impl-One-1" class="impl"><code class="in-band">impl One for f64</code><a href="#impl-One-1" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#152" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-2" class="method hidden"><code>fn <a href="#method.one-2" class="fnname">one</a>() -> f64</code><a class="srclink" href="../../src/num_traits/identities.rs.html#152" title="goto source code">[src]</a></h4><h4 id="method.is_one-2" class="method hidden"><code>fn <a href="#method.is_one-2" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#152" title="goto source code">[src]</a></h4></div><h3 id="impl-One-2" class="impl"><code class="in-band">impl One for i8</code><a href="#impl-One-2" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#144" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-3" class="method hidden"><code>fn <a href="#method.one-3" class="fnname">one</a>() -> i8</code><a class="srclink" href="../../src/num_traits/identities.rs.html#144" title="goto source code">[src]</a></h4><h4 id="method.is_one-3" class="method hidden"><code>fn <a href="#method.is_one-3" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#144" title="goto source code">[src]</a></h4></div><h3 id="impl-One-3" class="impl"><code class="in-band">impl One for i16</code><a href="#impl-One-3" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#145" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-4" class="method hidden"><code>fn <a href="#method.one-4" class="fnname">one</a>() -> i16</code><a class="srclink" href="../../src/num_traits/identities.rs.html#145" title="goto source code">[src]</a></h4><h4 id="method.is_one-4" class="method hidden"><code>fn <a href="#method.is_one-4" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#145" title="goto source code">[src]</a></h4></div><h3 id="impl-One-4" class="impl"><code class="in-band">impl One for i32</code><a href="#impl-One-4" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#146" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-5" class="method hidden"><code>fn <a href="#method.one-5" class="fnname">one</a>() -> i32</code><a class="srclink" href="../../src/num_traits/identities.rs.html#146" title="goto source code">[src]</a></h4><h4 id="method.is_one-5" class="method hidden"><code>fn <a href="#method.is_one-5" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#146" title="goto source code">[src]</a></h4></div><h3 id="impl-One-5" class="impl"><code class="in-band">impl One for i64</code><a href="#impl-One-5" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#147" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-6" class="method hidden"><code>fn <a href="#method.one-6" class="fnname">one</a>() -> i64</code><a class="srclink" href="../../src/num_traits/identities.rs.html#147" title="goto source code">[src]</a></h4><h4 id="method.is_one-6" class="method hidden"><code>fn <a href="#method.is_one-6" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#147" title="goto source code">[src]</a></h4></div><h3 id="impl-One-6" class="impl"><code class="in-band">impl One for i128</code><a href="#impl-One-6" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#149" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-7" class="method hidden"><code>fn <a href="#method.one-7" class="fnname">one</a>() -> i128</code><a class="srclink" href="../../src/num_traits/identities.rs.html#149" title="goto source code">[src]</a></h4><h4 id="method.is_one-7" class="method hidden"><code>fn <a href="#method.is_one-7" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#149" title="goto source code">[src]</a></h4></div><h3 id="impl-One-7" class="impl"><code class="in-band">impl One for isize</code><a href="#impl-One-7" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#143" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-8" class="method hidden"><code>fn <a href="#method.one-8" class="fnname">one</a>() -> isize</code><a class="srclink" href="../../src/num_traits/identities.rs.html#143" title="goto source code">[src]</a></h4><h4 id="method.is_one-8" class="method hidden"><code>fn <a href="#method.is_one-8" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#143" title="goto source code">[src]</a></h4></div><h3 id="impl-One-8" class="impl"><code class="in-band">impl One for u8</code><a href="#impl-One-8" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#136" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-9" class="method hidden"><code>fn <a href="#method.one-9" class="fnname">one</a>() -> u8</code><a class="srclink" href="../../src/num_traits/identities.rs.html#136" title="goto source code">[src]</a></h4><h4 id="method.is_one-9" class="method hidden"><code>fn <a href="#method.is_one-9" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#136" title="goto source code">[src]</a></h4></div><h3 id="impl-One-9" class="impl"><code class="in-band">impl One for u16</code><a href="#impl-One-9" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#137" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-10" class="method hidden"><code>fn <a href="#method.one-10" class="fnname">one</a>() -> u16</code><a class="srclink" href="../../src/num_traits/identities.rs.html#137" title="goto source code">[src]</a></h4><h4 id="method.is_one-10" class="method hidden"><code>fn <a href="#method.is_one-10" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#137" title="goto source code">[src]</a></h4></div><h3 id="impl-One-10" class="impl"><code class="in-band">impl One for u32</code><a href="#impl-One-10" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#138" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-11" class="method hidden"><code>fn <a href="#method.one-11" class="fnname">one</a>() -> u32</code><a class="srclink" href="../../src/num_traits/identities.rs.html#138" title="goto source code">[src]</a></h4><h4 id="method.is_one-11" class="method hidden"><code>fn <a href="#method.is_one-11" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#138" title="goto source code">[src]</a></h4></div><h3 id="impl-One-11" class="impl"><code class="in-band">impl One for u64</code><a href="#impl-One-11" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#139" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-12" class="method hidden"><code>fn <a href="#method.one-12" class="fnname">one</a>() -> u64</code><a class="srclink" href="../../src/num_traits/identities.rs.html#139" title="goto source code">[src]</a></h4><h4 id="method.is_one-12" class="method hidden"><code>fn <a href="#method.is_one-12" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#139" title="goto source code">[src]</a></h4></div><h3 id="impl-One-12" class="impl"><code class="in-band">impl One for u128</code><a href="#impl-One-12" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#141" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-13" class="method hidden"><code>fn <a href="#method.one-13" class="fnname">one</a>() -> u128</code><a class="srclink" href="../../src/num_traits/identities.rs.html#141" title="goto source code">[src]</a></h4><h4 id="method.is_one-13" class="method hidden"><code>fn <a href="#method.is_one-13" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#141" title="goto source code">[src]</a></h4></div><h3 id="impl-One-13" class="impl"><code class="in-band">impl One for usize</code><a href="#impl-One-13" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.one-14" class="method hidden"><code>fn <a href="#method.one-14" class="fnname">one</a>() -> usize</code><a class="srclink" href="../../src/num_traits/identities.rs.html#135" title="goto source code">[src]</a></h4><h4 id="method.is_one-14" class="method hidden"><code>fn <a href="#method.is_one-14" class="fnname">is_one</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#135" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/num_traits/identities/trait.One.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "num_traits";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |