15 lines
9.2 KiB
HTML
15 lines
9.2 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="This trait marks cart types that do not change source on cloning"><title>CloneableCart in yoke - 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 trait"><!--[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="#">CloneableCart</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="#">Cloneable<wbr>Cart</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-CloneableCart-for-%26T" title="&'a T">&'a T</a></li><li><a href="#impl-CloneableCart-for-()" title="()">()</a></li><li><a href="#impl-CloneableCart-for-Option%3CT%3E" title="Option<T>">Option<T></a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></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>Trait <span class="trait">Cloneable<wbr>Cart</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/yoke.rs.html#676">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait CloneableCart: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> { }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait marks cart types that do not change source on cloning</p>
|
||
<p>This is conceptually similar to <a href="../stable_deref_trait/trait.CloneStableDeref.html" title="trait stable_deref_trait::CloneStableDeref"><code>stable_deref_trait::CloneStableDeref</code></a>,
|
||
however <a href="../stable_deref_trait/trait.CloneStableDeref.html" title="trait stable_deref_trait::CloneStableDeref"><code>stable_deref_trait::CloneStableDeref</code></a> is not (and should not) be
|
||
implemented on <a href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option"><code>Option</code></a> (since it’s not <a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref"><code>Deref</code></a>). <a href="trait.CloneableCart.html" title="trait yoke::CloneableCart"><code>CloneableCart</code></a> essentially is
|
||
“if there <em>is</em> data to borrow from here, cloning the cart gives you an additional
|
||
handle to the same data”.</p>
|
||
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
||
<p>This trait is safe to implement on <code>StableDeref</code> types which, once <code>Clone</code>d, point to the same underlying data and retain ownership.</p>
|
||
<p>This trait can also be implemented on aggregates of such types like <code>Option<T: CloneableCart></code> and <code>(T: CloneableCart, U: CloneableCart)</code>.</p>
|
||
<p>Essentially, all data that could be referenced by a Yokeable (i.e. data that is referenced via a StableDeref) must retain the same
|
||
pointer and ownership semantics once cloned.</p>
|
||
</div></details><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-CloneableCart-for-()" class="impl"><a class="src rightside" href="../src/yoke/yoke.rs.html#690">Source</a><a href="#impl-CloneableCart-for-()" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a></h3></section><section id="impl-CloneableCart-for-%26T" class="impl"><a class="src rightside" href="../src/yoke/yoke.rs.html#688">Source</a><a href="#impl-CloneableCart-for-%26T" class="anchor">§</a><h3 class="code-header">impl<'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'a T</a></h3></section><section id="impl-CloneableCart-for-Option%3CT%3E" class="impl"><a class="src rightside" href="../src/yoke/yoke.rs.html#685">Source</a><a href="#impl-CloneableCart-for-Option%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a>> <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a> for <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-CloneableCart-for-EitherCart%3CC0,+C1%3E" class="impl"><a class="src rightside" href="../src/yoke/either.rs.html#83-88">Source</a><a href="#impl-CloneableCart-for-EitherCart%3CC0,+C1%3E" class="anchor">§</a><h3 class="code-header">impl<C0, C1> <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a> for <a class="enum" href="either/enum.EitherCart.html" title="enum yoke::either::EitherCart">EitherCart</a><C0, C1><div class="where">where
|
||
C0: <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a>,
|
||
C1: <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a>,</div></h3></section><section id="impl-CloneableCart-for-CartableOptionPointer%3CC%3E" class="impl"><a class="src rightside" href="../src/yoke/cartable_ptr.rs.html#367-370">Source</a><a href="#impl-CloneableCart-for-CartableOptionPointer%3CC%3E" class="anchor">§</a><h3 class="code-header">impl<C> <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a> for <a class="struct" href="cartable_ptr/struct.CartableOptionPointer.html" title="struct yoke::cartable_ptr::CartableOptionPointer">CartableOptionPointer</a><C><div class="where">where
|
||
C: <a class="trait" href="cartable_ptr/trait.CloneableCartablePointerLike.html" title="trait yoke::cartable_ptr::CloneableCartablePointerLike">CloneableCartablePointerLike</a> + <a class="trait" href="trait.CloneableCart.html" title="trait yoke::CloneableCart">CloneableCart</a>,</div></h3></section></div><script src="../trait.impl/yoke/yoke/trait.CloneableCart.js" data-ignore-extern-crates="core,std" async></script></section></div></main></body></html> |