15 lines
5.4 KiB
HTML
15 lines
5.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="Types for optional pointers with niche optimization."><title>yoke::cartable_ptr - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="yoke" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module cartable_ptr</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../yoke/index.html">yoke</a><span class="version">0.8.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module cartable_<wbr>ptr</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate yoke</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">yoke</a></div><h1>Module <span>cartable_<wbr>ptr</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/yoke/cartable_ptr.rs.html#5-445">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types for optional pointers with niche optimization.</p>
|
|
<p>The main type is <a href="struct.CartableOptionPointer.html" title="struct yoke::cartable_ptr::CartableOptionPointer"><code>CartableOptionPointer</code></a>, which is like <code>Option<Rc></code> but
|
|
with a niche so that the resulting <code>Yoke</code> has a niche. The following four
|
|
types can be stored in the <code>CartableOptionPointer</code>:</p>
|
|
<ol>
|
|
<li><code>&T</code></li>
|
|
<li><code>Box<T></code></li>
|
|
<li><code>Rc<T></code></li>
|
|
<li><code>Arc<T></code></li>
|
|
</ol>
|
|
<p>These four types implement the sealed unsafe trait <a href="trait.CartablePointerLike.html" title="trait yoke::cartable_ptr::CartablePointerLike"><code>CartablePointerLike</code></a>.
|
|
In addition, all except <code>Box<T></code> impl <a href="trait.CloneableCartablePointerLike.html" title="trait yoke::cartable_ptr::CloneableCartablePointerLike"><code>CloneableCartablePointerLike</code></a>,
|
|
which allows <a href="struct.CartableOptionPointer.html" title="struct yoke::cartable_ptr::CartableOptionPointer"><code>CartableOptionPointer</code></a> to implement <code>Clone</code>.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CartableOptionPointer.html" title="struct yoke::cartable_ptr::CartableOptionPointer">Cartable<wbr>Option<wbr>Pointer</a></dt><dd>A type with similar semantics as <code>Option<C<T>></code> but with a niche.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.CartablePointerLike.html" title="trait yoke::cartable_ptr::CartablePointerLike">Cartable<wbr>Pointer<wbr>Like</a></dt><dd>An object fully representable by a non-null pointer.</dd><dt><a class="trait" href="trait.CloneableCartablePointerLike.html" title="trait yoke::cartable_ptr::CloneableCartablePointerLike">Cloneable<wbr>Cartable<wbr>Pointer<wbr>Like</a></dt><dd>An object that implements <a href="trait.CartablePointerLike.html" title="trait yoke::cartable_ptr::CartablePointerLike"><code>CartablePointerLike</code></a> that also
|
|
supports cloning without changing the address of referenced data.</dd></dl></section></div></main></body></html> |