184 lines
No EOL
9 KiB
HTML
184 lines
No EOL
9 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 `cmp` mod in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, cmp">
|
||
|
||
<title>bitflags::__core::cmp - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a></p><script>window.sidebarCurrent = {name: 'cmp', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content mod">
|
||
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a class='mod' href=''>cmp</a></span><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 id='src-21821' class='srclink' href='https://doc.rust-lang.org/nightly/core/cmp/index.html?gotosrc=21821' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Functionality for ordering and comparison.</p>
|
||
|
||
<p>This module defines both <code>PartialOrd</code> and <code>PartialEq</code> traits which are used
|
||
by the compiler to implement comparison operators. Rust programs may
|
||
implement <code>PartialOrd</code> to overload the <code><</code>, <code><=</code>, <code>></code>, and <code>>=</code> operators,
|
||
and may implement <code>PartialEq</code> to overload the <code>==</code> and <code>!=</code> operators.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>let</span> <span class='ident'>x</span>: <span class='ident'>u32</span> <span class='op'>=</span> <span class='number'>0</span>;
|
||
<span class='kw'>let</span> <span class='ident'>y</span>: <span class='ident'>u32</span> <span class='op'>=</span> <span class='number'>1</span>;
|
||
|
||
<span class='comment'>// these two lines are equivalent</span>
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span> <span class='op'><</span> <span class='ident'>y</span>, <span class='boolval'>true</span>);
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>.<span class='ident'>lt</span>(<span class='kw-2'>&</span><span class='ident'>y</span>), <span class='boolval'>true</span>);
|
||
|
||
<span class='comment'>// these two lines are also equivalent</span>
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span> <span class='op'>==</span> <span class='ident'>y</span>, <span class='boolval'>false</span>);
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>.<span class='ident'>eq</span>(<span class='kw-2'>&</span><span class='ident'>y</span>), <span class='boolval'>false</span>);</pre>
|
||
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class='enum' href='enum.Ordering.html'
|
||
title='bitflags::__core::cmp::Ordering'>Ordering</a></td>
|
||
<td class='docblock short'>
|
||
<p>An <code>Ordering</code> is the result of a comparison between two values.</p>
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.Eq.html'
|
||
title='bitflags::__core::cmp::Eq'>Eq</a></td>
|
||
<td class='docblock short'>
|
||
<p>Trait for equality comparisons which are <a href="https://en.wikipedia.org/wiki/Equivalence_relation">equivalence relations</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.Ord.html'
|
||
title='bitflags::__core::cmp::Ord'>Ord</a></td>
|
||
<td class='docblock short'>
|
||
<p>Trait for types that form a <a href="https://en.wikipedia.org/wiki/Total_order">total order</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.PartialEq.html'
|
||
title='bitflags::__core::cmp::PartialEq'>PartialEq</a></td>
|
||
<td class='docblock short'>
|
||
<p>Trait for equality comparisons which are <a href="http://en.wikipedia.org/wiki/Partial_equivalence_relation">partial equivalence
|
||
relations</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='trait' href='trait.PartialOrd.html'
|
||
title='bitflags::__core::cmp::PartialOrd'>PartialOrd</a></td>
|
||
<td class='docblock short'>
|
||
<p>Trait for values that can be compared for a sort-order.</p>
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class='fn' href='fn.max.html'
|
||
title='bitflags::__core::cmp::max'>max</a></td>
|
||
<td class='docblock short'>
|
||
<p>Compare and return the maximum of two values.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class='fn' href='fn.min.html'
|
||
title='bitflags::__core::cmp::min'>min</a></td>
|
||
<td class='docblock short'>
|
||
<p>Compare and return the minimum of two values.</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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |