mentat/docs/apis/rust/iovec/unix/fn.as_os_slice.html

140 lines
6.7 KiB
HTML
Raw Normal View History

2018-06-21 14:44:35 +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">
<meta name="description" content="API documentation for the Rust `as_os_slice` fn in crate `iovec`.">
<meta name="keywords" content="rust, rustlang, rust-lang, as_os_slice">
<title>iovec::unix::as_os_slice - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css"
id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc fn">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<div class="sidebar-elems"><p class='location'><a href='../index.html'>iovec</a>::<wbr><a href='index.html'>unix</a></p><script>window.sidebarCurrent = {name: 'as_os_slice', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<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"><h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>iovec</a>::<wbr><a href='index.html'>unix</a>::<wbr><a class="fn" href=''>as_os_slice</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/iovec/unix.rs.html#44-46' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn as_os_slice&lt;'a&gt;(iov: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a>&amp;<a class="struct" href="../../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="struct" href="../../libc/unix/struct.iovec.html" title="struct libc::unix::iovec">iovec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></pre><div class='docblock'><p>Convert a slice of <code>IoVec</code> refs to a slice of <code>libc::iovec</code>.</p>
<p>The return value can be passed to <code>writev</code> bindings.</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">iovec</span>::<span class="ident">IoVec</span>;
<span class="kw">use</span> <span class="ident">iovec</span>::<span class="ident">unix</span>;
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="string">b&quot;hello&quot;</span>.<span class="ident">to_vec</span>();
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="string">b&quot;world&quot;</span>.<span class="ident">to_vec</span>();
<span class="kw">let</span> <span class="ident">bufs</span>: <span class="kw-2">&amp;</span>[<span class="kw-2">&amp;</span><span class="ident">IoVec</span>] <span class="op">=</span> <span class="kw-2">&amp;</span>[<span class="ident">a</span>[..].<span class="ident">into</span>(), <span class="ident">b</span>[..].<span class="ident">into</span>()];
<span class="kw">let</span> <span class="ident">os_bufs</span> <span class="op">=</span> <span class="ident">unix</span>::<span class="ident">as_os_slice</span>(<span class="ident">bufs</span>);
<span class="comment">// Use the `os_bufs` slice with `writev`.</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><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse 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 = "iovec";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>