mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-01-17 06:22:54 +00:00
179 lines
18 KiB
HTML
179 lines
18 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 `OwningHandle` struct in crate `owning_ref`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, OwningHandle">
|
||
|
||
<title>owning_ref::OwningHandle - 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="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[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">☰</div>
|
||
|
||
<p class='location'>Struct OwningHandle</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.new_mut">new_mut</a><a href="#method.new_with_fn">new_with_fn</a><a href="#method.try_new">try_new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Deref">Deref</a><a href="#impl-StableAddress">StableAddress</a><a href="#impl-DerefMut">DerefMut</a></div></div><p class='location'><a href='index.html'>owning_ref</a></p><script>window.sidebarCurrent = {name: 'OwningHandle', ty: 'struct', 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'>Struct <a href='index.html'>owning_ref</a>::<wbr><a class="struct" href=''>OwningHandle</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 class='srclink' href='../src/owning_ref/lib.rs.html#752-757' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct OwningHandle<O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>, </span> { /* fields omitted */ }</pre><div class='docblock'><p><code>OwningHandle</code> is a complement to <code>OwningRef</code>. Where <code>OwningRef</code> allows
|
||
consumers to pass around an owned object and a dependent reference,
|
||
<code>OwningHandle</code> contains an owned object and a dependent <em>object</em>.</p>
|
||
<p><code>OwningHandle</code> can encapsulate a <code>RefMut</code> along with its associated
|
||
<code>RefCell</code>, or an <code>RwLockReadGuard</code> along with its associated <code>RwLock</code>.
|
||
However, the API is completely generic and there are no restrictions on
|
||
what types of owning and dependent objects may be used.</p>
|
||
<p><code>OwningHandle</code> is created by passing an owner object (which dereferences
|
||
to a stable address) along with a callback which receives a pointer to
|
||
that stable location. The callback may then dereference the pointer and
|
||
mint a dependent object, with the guarantee that the returned object will
|
||
not outlive the referent of the pointer.</p>
|
||
<p>Since the callback needs to dereference a raw pointer, it requires <code>unsafe</code>
|
||
code. To avoid forcing this unsafety on most callers, the <code>ToHandle</code> trait is
|
||
implemented for common data structures. Types that implement <code>ToHandle</code> can
|
||
be wrapped into an <code>OwningHandle</code> without passing a callback.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl<O, H> <a class="struct" href="../owning_ref/struct.OwningHandle.html" title="struct owning_ref::OwningHandle">OwningHandle</a><O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> O::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../owning_ref/trait.ToHandle.html" title="trait owning_ref::ToHandle">ToHandle</a><Handle = H>,<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>, </span></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#800-809' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(o: O) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#806-808' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new <code>OwningHandle</code> for a type that implements <code>ToHandle</code>. For types
|
||
that don't implement <code>ToHandle</code>, callers may invoke <code>new_with_fn</code>, which accepts
|
||
a callback to perform the conversion.</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl<O, H> <a class="struct" href="../owning_ref/struct.OwningHandle.html" title="struct owning_ref::OwningHandle">OwningHandle</a><O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> O::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../owning_ref/trait.ToHandleMut.html" title="trait owning_ref::ToHandleMut">ToHandleMut</a><HandleMut = H>,<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a>, </span></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#811-818' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new_mut' class="method"><span id='new_mut.v' class='invisible'><code>pub fn <a href='#method.new_mut' class='fnname'>new_mut</a>(o: O) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#815-817' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new mutable <code>OwningHandle</code> for a type that implements <code>ToHandleMut</code>.</p>
|
||
</div></div><h3 id='impl-2' class='impl'><span class='in-band'><code>impl<O, H> <a class="struct" href="../owning_ref/struct.OwningHandle.html" title="struct owning_ref::OwningHandle">OwningHandle</a><O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>, </span></code><a href='#impl-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#820-858' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new_with_fn' class="method"><span id='new_with_fn.v' class='invisible'><code>pub fn <a href='#method.new_with_fn' class='fnname'>new_with_fn</a><F>(o: O, f: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a>O::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>) -> H, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#827-839' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new OwningHandle. The provided callback will be invoked with
|
||
a pointer to the object owned by <code>o</code>, and the returned value is stored
|
||
as the object to which this <code>OwningHandle</code> will forward <code>Deref</code> and
|
||
<code>DerefMut</code>.</p>
|
||
</div><h4 id='method.try_new' class="method"><span id='try_new.v' class='invisible'><code>pub fn <a href='#method.try_new' class='fnname'>try_new</a><F, E>(o: O, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, E> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a>O::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><H, E>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#845-857' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new OwningHandle. The provided callback will be invoked with
|
||
a pointer to the object owned by <code>o</code>, and the returned value is stored
|
||
as the object to which this <code>OwningHandle</code> will forward <code>Deref</code> and
|
||
<code>DerefMut</code>.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl<O, H> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../owning_ref/struct.OwningHandle.html" title="struct owning_ref::OwningHandle">OwningHandle</a><O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>, </span></code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#759-766' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = H::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></span></h4>
|
||
<div class='docblock'><p>The resulting type after dereferencing.</p>
|
||
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &H::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#763-765' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Dereferences the value.</p>
|
||
</div></div><h3 id='impl-StableAddress' class='impl'><span class='in-band'><code>impl<O, H> <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a> for <a class="struct" href="../owning_ref/struct.OwningHandle.html" title="struct owning_ref::OwningHandle">OwningHandle</a><O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> H: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>, </span></code><a href='#impl-StableAddress' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#768-770' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl<O, H> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../owning_ref/struct.OwningHandle.html" title="struct owning_ref::OwningHandle">OwningHandle</a><O, H> <span class="where fmt-newline">where<br> O: <a class="trait" href="../owning_ref/trait.StableAddress.html" title="trait owning_ref::StableAddress">StableAddress</a>,<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a>, </span></code><a href='#impl-DerefMut' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#772-778' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut H::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/owning_ref/lib.rs.html#775-777' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Mutably dereferences the value.</p>
|
||
</div></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>⏎</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 = "owning_ref";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |