<!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 `max` fn in crate `compare`.">
<meta name="keywords" content="rust, rustlang, rust-lang, max">
<title>compare::max - 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'>compare</a></p><script>window.sidebarCurrent = {name: 'max', ty: 'fn', 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 fn">
<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>compare</a>::<wbr><a class='fn' href=''>max</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-9' class='srclink' href='../src/compare/lib.rs.html#155-159' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn max<'a, C: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>, T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>>(cmp: &C, l: &'a T, r: &'a T) -> &'a T <span class='where'>where C: <a class='trait' href='../compare/trait.Compare.html' title='compare::Compare'>Compare</a><T></span></pre><div class='docblock'><p>Returns the maximum of two values according to the given comparator, or <code>r</code> if they
are equal.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>compare</span>::{<span class='ident'>Extract</span>, <span class='ident'>max</span>};
<span class='kw'>struct</span> <span class='ident'>Foo</span> { <span class='ident'>key</span>: <span class='ident'>char</span>, <span class='ident'>id</span>: <span class='ident'>u8</span> }
<span class='kw'>let</span> <span class='ident'>f1</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='ident'>Foo</span> { <span class='ident'>key</span>: <span class='string'>'a'</span>, <span class='ident'>id</span>: <span class='number'>1</span>};
<span class='kw'>let</span> <span class='ident'>f2</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='ident'>Foo</span> { <span class='ident'>key</span>: <span class='string'>'a'</span>, <span class='ident'>id</span>: <span class='number'>2</span>};
<span class='kw'>let</span> <span class='ident'>f3</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='ident'>Foo</span> { <span class='ident'>key</span>: <span class='string'>'b'</span>, <span class='ident'>id</span>: <span class='number'>3</span>};
<span class='kw'>let</span> <span class='ident'>cmp</span> <span class='op'>=</span> <span class='ident'>Extract</span>::<span class='ident'>new</span>(<span class='op'>|</span><span class='ident'>f</span>: <span class='kw-2'>&</span><span class='ident'>Foo</span><span class='op'>|</span> <span class='ident'>f</span>.<span class='ident'>key</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>max</span>(<span class='kw-2'>&</span><span class='ident'>cmp</span>, <span class='ident'>f1</span>, <span class='ident'>f2</span>).<span class='ident'>id</span>, <span class='ident'>f2</span>.<span class='ident'>id</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>max</span>(<span class='kw-2'>&</span><span class='ident'>cmp</span>, <span class='ident'>f1</span>, <span class='ident'>f3</span>).<span class='ident'>id</span>, <span class='ident'>f3</span>.<span class='ident'>id</span>);</pre>
</div></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 = "compare";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>