162 lines
No EOL
9.4 KiB
HTML
162 lines
No EOL
9.4 KiB
HTML
<!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 `Slice` struct in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Slice">
|
||
|
||
<title>bitflags::__core::raw::Slice - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>raw</a></p><script>window.sidebarCurrent = {name: 'Slice', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</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 struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>raw</a>::<wbr><a class='struct' href=''>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'>−</span>]
|
||
</a>
|
||
</span><a id='src-30471' class='srclink' href='https://doc.rust-lang.org/nightly/core/raw/struct.Slice.html?gotosrc=30471' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Slice<T> {
|
||
pub data: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.pointer.html'>*const T</a>,
|
||
pub len: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.usize.html'>usize</a>,
|
||
}</pre><div class='stability'><em class='stab deprecated'>Deprecated since 1.9.0<p>: use raw accessors/constructors in <code>slice</code> module</p>
|
||
</em></div><div class='stability'><em class='stab unstable'>Unstable (<code>raw</code>)<p>: use raw accessors/constructors in <code>slice</code> module</p>
|
||
</em></div><div class='docblock'><p>The representation of a slice like <code>&[T]</code>.</p>
|
||
|
||
<p>This struct is guaranteed to have the layout of types like <code>&[T]</code>,
|
||
<code>&str</code>, and <code>Box<[T]></code>, but is not the type of such slices
|
||
(e.g. the fields are not directly accessible on a <code>&[T]</code>) nor does
|
||
it control that layout (changing the definition will not change
|
||
the layout of a <code>&[T]</code>). It is only designed to be used by unsafe
|
||
code that needs to manipulate the low-level details.</p>
|
||
|
||
<p>However, it is not recommended to use this type for such code,
|
||
since there are alternatives which may be safer:</p>
|
||
|
||
<ul>
|
||
<li>Creating a slice from a data pointer and length can be done with
|
||
<code>std::slice::from_raw_parts</code> or <code>std::slice::from_raw_parts_mut</code>
|
||
instead of <code>std::mem::transmute</code>ing a value of type <code>Slice</code>.</li>
|
||
<li>Extracting the data pointer and length from a slice can be
|
||
performed with the <code>as_ptr</code> (or <code>as_mut_ptr</code>) and <code>len</code>
|
||
methods.</li>
|
||
</ul>
|
||
|
||
<p>If one does decide to convert a slice value to a <code>Slice</code>, the
|
||
<code>Repr</code> trait in this module provides a method for a safe
|
||
conversion from <code>&[T]</code> (and <code>&str</code>) to a <code>Slice</code>, more type-safe
|
||
than a call to <code>transmute</code>.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>raw</span>)]</span>
|
||
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>raw</span>::{<span class='self'>self</span>, <span class='ident'>Repr</span>};
|
||
|
||
<span class='kw'>let</span> <span class='ident'>slice</span>: <span class='kw-2'>&</span>[<span class='ident'>u16</span>] <span class='op'>=</span> <span class='kw-2'>&</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>];
|
||
|
||
<span class='kw'>let</span> <span class='ident'>repr</span>: <span class='ident'>raw</span>::<span class='ident'>Slice</span><span class='op'><</span><span class='ident'>u16</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>slice</span>.<span class='ident'>repr</span>();
|
||
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"data pointer = {:?}, length = {}"</span>, <span class='ident'>repr</span>.<span class='ident'>data</span>, <span class='ident'>repr</span>.<span class='ident'>len</span>);</pre>
|
||
</div><h2 class='fields'>Fields</h2>
|
||
<table><tr class='stab unstable deprecated'>
|
||
<td id='structfield.data'><code>data</code></td><td><div class='stability'><em class='stab deprecated'>Deprecated since 1.9.0<p>: use raw accessors/constructors in <code>slice</code> module</p>
|
||
</em></div><div class='stability'><em class='stab unstable'>Unstable (<code>raw</code>)<p>: use raw accessors/constructors in <code>slice</code> module</p>
|
||
</em></div></td></tr><tr class='stab unstable deprecated'>
|
||
<td id='structfield.len'><code>len</code></td><td><div class='stability'><em class='stab deprecated'>Deprecated since 1.9.0<p>: use raw accessors/constructors in <code>slice</code> module</p>
|
||
</em></div><div class='stability'><em class='stab unstable'>Unstable (<code>raw</code>)<p>: use raw accessors/constructors in <code>slice</code> module</p>
|
||
</em></div></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> for <a class='struct' href='../../../bitflags/__core/raw/struct.Slice.html' title='bitflags::__core::raw::Slice'>Slice</a><T></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a> for <a class='struct' href='../../../bitflags/__core/raw/struct.Slice.html' title='bitflags::__core::raw::Slice'>Slice</a><T></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class='struct' href='../../../bitflags/__core/raw/struct.Slice.html' title='bitflags::__core::raw::Slice'>Slice</a><T></code></h4>
|
||
<div class='stability'><em class='stab unstable'>Unstable (<code>raw</code>)</em></div><h4 id='method.clone_from' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><span class="since">1.0.0</span></h4>
|
||
</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>⇤</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>
|
||
</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 = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |