pnmixer-rust/which/index.html

140 lines
5.1 KiB
HTML
Raw Normal View History

2017-07-14 23:24:09 +00:00
<!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">
2017-07-14 23:30:16 +00:00
<meta name="description" content="API documentation for the Rust `which` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, which">
2017-07-14 23:24:09 +00:00
2017-07-14 23:30:16 +00:00
<title>which - Rust</title>
2017-07-14 23:24:09 +00:00
2017-07-14 23:30:16 +00:00
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
2017-07-14 23:24:09 +00:00
</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">
2017-07-14 23:30:16 +00:00
<p class='location'>Crate which</p><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'which', ty: 'mod', relpath: '../'};</script>
2017-07-14 23:24:09 +00:00
</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">
2017-07-14 23:30:16 +00:00
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>which</a></span><span class='out-of-band'><span id='render-detail'>
2017-07-14 23:24:09 +00:00
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
2017-07-14 23:30:16 +00:00
</span><a class='srclink' href='../src/which/lib.rs.html#1-445' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>which</p>
<p>A Rust equivalent of Unix command <code>which(1)</code>.</p>
<h1 id='example' class='section-header'><a href='#example'>Example:</a></h1>
<p>To find which rustc executable binary is using:</p>
<pre><code class="language-norun">use which::which;
let result = which::which(&quot;rustc&quot;).unwrap();
assert_eq!(result, PathBuf::from(&quot;/usr/bin/rustc&quot;));
</code></pre>
2017-07-14 23:24:09 +00:00
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
2017-07-14 23:30:16 +00:00
<td><a class="fn" href="fn.which.html"
title='fn which::which'>which</a></td>
2017-07-14 23:24:09 +00:00
<td class='docblock-short'>
2017-07-14 23:30:16 +00:00
<p>Find a exectable binary&#39;s path by name.</p>
2017-07-14 23:24:09 +00:00
</td>
</tr>
<tr class=' module-item'>
2017-07-14 23:30:16 +00:00
<td><a class="fn" href="fn.which_in.html"
title='fn which::which_in'>which_in</a></td>
2017-07-14 23:24:09 +00:00
<td class='docblock-short'>
2017-07-14 23:30:16 +00:00
<p>Find <code>binary_name</code> in the path list <code>paths</code>, using <code>cwd</code> to resolve relative paths.</p>
2017-07-14 23:24:09 +00:00
</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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
2017-07-14 23:30:16 +00:00
window.rootPath = "../";
window.currentCrate = "which";
2017-07-14 23:24:09 +00:00
</script>
2017-07-14 23:30:16 +00:00
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
2017-07-14 23:24:09 +00:00
</body>
</html>