blob: d5042bc1919abdc1e8c54ca01438233e37d2ce44 [file] [log] [blame]
<!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="Source to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/nix-0.8.1/src/net/if_.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>if_.rs.html -- source</title>
<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>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
</pre><pre class="rust ">
<span class="doccomment">//! Network interface name resolution.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Uses Linux and/or POSIX functions to resolve interface names like &quot;eth0&quot;</span>
<span class="doccomment">//! or &quot;socan1&quot; into device numbers.</span>
<span class="kw">use</span> <span class="ident">libc</span>;
<span class="kw">use</span> <span class="ident">libc</span>::<span class="ident">c_uint</span>;
<span class="kw">use</span> {<span class="prelude-ty">Result</span>, <span class="ident">Error</span>, <span class="ident">NixPath</span>};
<span class="doccomment">/// Resolve an interface into a interface number.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">if_nametoindex</span><span class="op">&lt;</span><span class="ident">P</span>: <span class="question-mark">?</span><span class="ident">Sized</span> <span class="op">+</span> <span class="ident">NixPath</span><span class="op">&gt;</span>(<span class="ident">name</span>: <span class="kw-2">&amp;</span><span class="ident">P</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">c_uint</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">if_index</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">name</span>.<span class="ident">with_nix_path</span>(<span class="op">|</span><span class="ident">name</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">if_nametoindex</span>(<span class="ident">name</span>.<span class="ident">as_ptr</span>()) }));
<span class="kw">if</span> <span class="ident">if_index</span> <span class="op">==</span> <span class="number">0</span> {
<span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">last</span>())
} <span class="kw">else</span> {
<span class="prelude-val">Ok</span>(<span class="ident">if_index</span>)
}
}
</pre>
</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 = "../../../";
window.currentCrate = "nix";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>