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 `c_vec` crate.">
|
|
|
|
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, c_vec">
|
2017-07-14 23:24:09 +00:00
|
|
|
|
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<title>c_vec - 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 c_vec</p><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'c_vec', 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=''>c_vec</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'>−</span>]
|
|
|
|
|
|
</a>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
</span><a class='srclink' href='../src/c_vec/c_vec.rs.html#10-397' title='goto source code'>[src]</a></span></h1>
|
|
|
|
|
|
<div class='docblock'><p>Library to interface with chunks of memory allocated in C.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>It is often desirable to safely interface with memory allocated from C,
|
|
|
|
|
|
encapsulating the unsafety into allocation and destruction time. Indeed,
|
|
|
|
|
|
allocating memory externally is currently the only way to give Rust shared
|
|
|
|
|
|
mut state with C programs that keep their own references; vectors are
|
|
|
|
|
|
unsuitable because they could be reallocated or moved at any time, and
|
|
|
|
|
|
importing C memory into a vector takes a one-time snapshot of the memory.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>This module simplifies the usage of such external blocks of memory. Memory
|
|
|
|
|
|
is encapsulated into an opaque object after creation; the lifecycle of the
|
|
|
|
|
|
memory can be optionally managed by Rust, if an appropriate destructor
|
|
|
|
|
|
closure is provided. Safety is ensured by bounds-checking accesses, which
|
|
|
|
|
|
are marshalled through get and set functions.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>There are three unsafe functions: the two constructors, and the
|
|
|
|
|
|
unwrapping method. The constructors are unsafe for the
|
|
|
|
|
|
obvious reason (they act on a pointer that cannot be checked inside the
|
|
|
|
|
|
method), but <code>into_inner()</code> is somewhat more subtle in its unsafety.
|
|
|
|
|
|
It returns the contained pointer, but at the same time destroys the CVec
|
|
|
|
|
|
without running its destructor. This can be used to pass memory back to
|
|
|
|
|
|
C, but care must be taken that the ownership of underlying resources are
|
|
|
|
|
|
handled correctly, i.e. that allocated memory is eventually freed
|
|
|
|
|
|
if necessary.</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="struct" href="struct.CSlice.html"
|
|
|
|
|
|
title='struct c_vec::CSlice'>CSlice</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>The type representing an 'unsafe' foreign chunk of memory</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="struct" href="struct.CVec.html"
|
|
|
|
|
|
title='struct c_vec::CVec'>CVec</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>The type representing a foreign chunk of memory</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>⇤</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>
|
|
|
|
|
|
<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 = "c_vec";
|
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>
|
