pnmixer-rust/which/fn.which.html

131 lines
5.2 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` fn in crate `which`.">
<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::which - Rust</title>
2017-07-14 23:24:09 +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">
</head>
2017-07-14 23:30:16 +00:00
<body class="rustdoc fn">
2017-07-14 23:24:09 +00:00
<!--[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'><a href='index.html'>which</a></p><script>window.sidebarCurrent = {name: 'which', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></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'>Function <a href='index.html'>which</a>::<wbr><a class="fn" 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#71-76' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn which&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>&gt;&gt;(binary_name: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</pre><div class='docblock'><p>Find a exectable binary&#39;s path by name.</p>
<p>If given an absolute path, returns it if the file exists and is executable.</p>
<p>If given a relative path, returns an absolute path to the file if
it exists and is executable.</p>
<p>If given a string without path separators, looks for a file named
<code>binary_name</code> at each directory in <code>$PATH</code> and if it finds an executable
file there, returns it.</p>
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
<pre><code class="language-norun">use which::which;
use std::path::PathBuf;
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></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>
window.rootPath = "../";
2017-07-14 23:30:16 +00:00
window.currentCrate = "which";
2017-07-14 23:24:09 +00:00
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>