70 lines
41 KiB
HTML
70 lines
41 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="Type-erased borrow of some unknown type chosen when constructing this type."><title>Ptr in bevy_ptr - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bevy_ptr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../bevy_ptr/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../bevy_ptr/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../bevy_ptr/index.html">bevy_<wbr>ptr</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Ptr</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_ptr" title="as_ptr">as_ptr</a></li><li><a href="#method.assert_unique" title="assert_unique">assert_unique</a></li><li><a href="#method.byte_add" title="byte_add">byte_add</a></li><li><a href="#method.byte_offset" title="byte_offset">byte_offset</a></li><li><a href="#method.deref" title="deref">deref</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.to_unaligned" title="to_unaligned">to_unaligned</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-Ptr%3C'a,+A%3E" title="Clone">Clone</a></li><li><a href="#impl-Copy-for-Ptr%3C'a,+A%3E" title="Copy">Copy</a></li><li><a href="#impl-Debug-for-Ptr%3C'a,+A%3E" title="Debug">Debug</a></li><li><a href="#impl-From%3C%26T%3E-for-Ptr%3C'a%3E" title="From<&'a T>">From<&'a T></a></li><li><a href="#impl-From%3CPtr%3C'a,+A%3E%3E-for-NonNull%3Cu8%3E" title="From<Ptr<'a, A>>">From<Ptr<'a, A>></a></li><li><a href="#impl-Pointer-for-Ptr%3C'_,+A%3E" title="Pointer">Pointer</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Send-for-Ptr%3C'a,+A%3E" title="!Send">!Send</a></li><li><a href="#impl-Sync-for-Ptr%3C'a,+A%3E" title="!Sync">!Sync</a></li><li><a href="#impl-Freeze-for-Ptr%3C'a,+A%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Ptr%3C'a,+A%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-Ptr%3C'a,+A%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Ptr%3C'a,+A%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bevy_<wbr>ptr</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bevy_ptr</a></span><h1>Struct <span class="struct">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/bevy_ptr/lib.rs.html#164">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Ptr<'a, A: <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a> = <a class="struct" href="struct.Aligned.html" title="struct bevy_ptr::Aligned">Aligned</a>>(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Type-erased borrow of some unknown type chosen when constructing this type.</p>
|
|
<p>This type tries to act “borrow-like” which means that:</p>
|
|
<ul>
|
|
<li>It should be considered immutable: its target must not be changed while this pointer is alive.</li>
|
|
<li>It must always points to a valid value of whatever the pointee type is.</li>
|
|
<li>The lifetime <code>'a</code> accurately represents how long the pointer is valid for.</li>
|
|
<li>Must be sufficiently aligned for the unknown pointee type.</li>
|
|
</ul>
|
|
<p>It may be helpful to think of this type as similar to <code>&'a dyn Any</code> but without
|
|
the metadata and able to point to data that does not correspond to a Rust type.</p>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Ptr%3C'a%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><a href="#impl-Ptr%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, <a class="struct" href="struct.Aligned.html" title="struct bevy_ptr::Aligned">Aligned</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.to_unaligned" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><h4 class="code-header">pub fn <a href="#method.to_unaligned" class="fn">to_unaligned</a>(self) -> <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, <a class="struct" href="struct.Unaligned.html" title="struct bevy_ptr::Unaligned">Unaligned</a>></h4></section></summary><div class="docblock"><p>Removes the alignment requirement of this pointer</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ptr%3C'_,+A%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><a href="#impl-Ptr%3C'_,+A%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'_, A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.byte_offset" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.byte_offset" class="fn">byte_offset</a>(self, count: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.isize.html">isize</a>) -> Self</h4></section></summary><div class="docblock"><p>Calculates the offset from a pointer.
|
|
As the pointer is type-erased, there is no size information available. The provided
|
|
<code>count</code> parameter is in raw bytes.</p>
|
|
<p><em>See also: <a href="https://doc.rust-lang.org/std/primitive.pointer.html#method.offset"><code>ptr::offset</code></a></em></p>
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
|
<ul>
|
|
<li>The offset cannot make the existing ptr null, or take it out of bounds for its allocation.</li>
|
|
<li>If the <code>A</code> type parameter is <a href="struct.Aligned.html" title="struct bevy_ptr::Aligned"><code>Aligned</code></a> then the offset must not make the resulting pointer
|
|
be unaligned for the pointee type.</li>
|
|
<li>The value pointed by the resulting pointer must outlive the lifetime of this pointer.</li>
|
|
</ul>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.byte_add" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.byte_add" class="fn">byte_add</a>(self, count: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>Calculates the offset from a pointer (convenience for <code>.offset(count as isize)</code>).
|
|
As the pointer is type-erased, there is no size information available. The provided
|
|
<code>count</code> parameter is in raw bytes.</p>
|
|
<p><em>See also: <a href="https://doc.rust-lang.org/std/primitive.pointer.html#method.add"><code>ptr::add</code></a></em></p>
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|
<ul>
|
|
<li>The offset cannot make the existing ptr null, or take it out of bounds for its allocation.</li>
|
|
<li>If the <code>A</code> type parameter is <a href="struct.Aligned.html" title="struct bevy_ptr::Aligned"><code>Aligned</code></a> then the offset must not make the resulting pointer
|
|
be unaligned for the pointee type.</li>
|
|
<li>The value pointed by the resulting pointer must outlive the lifetime of this pointer.</li>
|
|
</ul>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ptr%3C'a,+A%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#275-319">Source</a><a href="#impl-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A: <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#285-287">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.new" class="fn">new</a>(inner: <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/ptr/non_null/struct.NonNull.html" title="struct core::ptr::non_null::NonNull">NonNull</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u8.html">u8</a>>) -> Self</h4></section></summary><div class="docblock"><p>Creates a new instance from a raw pointer.</p>
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
|
|
<ul>
|
|
<li><code>inner</code> must point to valid value of whatever the pointee type is.</li>
|
|
<li>If the <code>A</code> type parameter is <a href="struct.Aligned.html" title="struct bevy_ptr::Aligned"><code>Aligned</code></a> then <code>inner</code> must be sufficiently aligned for the pointee type.</li>
|
|
<li><code>inner</code> must have correct provenance to allow reads of the pointee type.</li>
|
|
<li>The lifetime <code>'a</code> must be constrained such that this <a href="struct.Ptr.html" title="struct bevy_ptr::Ptr"><code>Ptr</code></a> will stay valid and nothing
|
|
can mutate the pointee while this <a href="struct.Ptr.html" title="struct bevy_ptr::Ptr"><code>Ptr</code></a> is live except through an <a href="https://doc.rust-lang.org/1.84.0/core/cell/struct.UnsafeCell.html" title="struct core::cell::UnsafeCell"><code>UnsafeCell</code></a>.</li>
|
|
</ul>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.assert_unique" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#294-296">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.assert_unique" class="fn">assert_unique</a>(self) -> <a class="struct" href="struct.PtrMut.html" title="struct bevy_ptr::PtrMut">PtrMut</a><'a, A></h4></section></summary><div class="docblock"><p>Transforms this <a href="struct.Ptr.html" title="struct bevy_ptr::Ptr"><code>Ptr</code></a> into an <a href="struct.PtrMut.html" title="struct bevy_ptr::PtrMut"><code>PtrMut</code></a></p>
|
|
<h5 id="safety-3"><a class="doc-anchor" href="#safety-3">§</a>Safety</h5>
|
|
<p>Another <a href="struct.PtrMut.html" title="struct bevy_ptr::PtrMut"><code>PtrMut</code></a> for the same <a href="struct.Ptr.html" title="struct bevy_ptr::Ptr"><code>Ptr</code></a> must not be created until the first is dropped.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#305-309">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.deref" class="fn">deref</a><T>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&'a T</a></h4></section></summary><div class="docblock"><p>Transforms this <a href="struct.Ptr.html" title="struct bevy_ptr::Ptr"><code>Ptr<T></code></a> into a <code>&T</code> with the same lifetime</p>
|
|
<h5 id="safety-4"><a class="doc-anchor" href="#safety-4">§</a>Safety</h5>
|
|
<ul>
|
|
<li><code>T</code> must be the erased pointee type for this <a href="struct.Ptr.html" title="struct bevy_ptr::Ptr"><code>Ptr</code></a>.</li>
|
|
<li>If the type parameter <code>A</code> is <a href="struct.Unaligned.html" title="struct bevy_ptr::Unaligned"><code>Unaligned</code></a> then this pointer must be sufficiently aligned
|
|
for the pointee type <code>T</code>.</li>
|
|
</ul>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ptr" class="method"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#316-318">Source</a><h4 class="code-header">pub fn <a href="#method.as_ptr" class="fn">as_ptr</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u8.html">u8</a></h4></section></summary><div class="docblock"><p>Gets the underlying pointer, erasing the associated lifetime.</p>
|
|
<p>If possible, it is strongly encouraged to use <a href="struct.Ptr.html#method.deref" title="method bevy_ptr::Ptr::deref"><code>deref</code></a> over this function,
|
|
as it retains the lifetime.</p>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Ptr%3C'a,+A%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#162">Source</a><a href="#impl-Clone-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#162">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#174">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Ptr%3C'a,+A%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#162">Source</a><a href="#impl-Debug-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#162">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3C%26T%3E-for-Ptr%3C'a%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#321-328">Source</a><a href="#impl-From%3C%26T%3E-for-Ptr%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&'a T</a>> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#323-327">Source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&'a T</a>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CPtr%3C'a,+A%3E%3E-for-NonNull%3Cu8%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><a href="#impl-From%3CPtr%3C'a,+A%3E%3E-for-NonNull%3Cu8%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A: <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A>> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/ptr/non_null/struct.NonNull.html" title="struct core::ptr::non_null::NonNull">NonNull</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u8.html">u8</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(ptr: <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Pointer-for-Ptr%3C'_,+A%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><a href="#impl-Pointer-for-Ptr%3C'_,+A%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Pointer.html" title="trait core::fmt::Pointer">Pointer</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'_, A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#271">Source</a><a href="#method.fmt-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Pointer.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Pointer.html#tymethod.fmt">Read more</a></div></details></div></details><section id="impl-Copy-for-Ptr%3C'a,+A%3E" class="impl"><a class="src rightside" href="../src/bevy_ptr/lib.rs.html#162">Source</a><a href="#impl-Copy-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="trait.IsAligned.html" title="trait bevy_ptr::IsAligned">IsAligned</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Ptr%3C'a,+A%3E" class="impl"><a href="#impl-Freeze-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section><section id="impl-RefUnwindSafe-for-Ptr%3C'a,+A%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A><div class="where">where
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-Ptr%3C'a,+A%3E" class="impl"><a href="#impl-Send-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A = <a class="struct" href="struct.Aligned.html" title="struct bevy_ptr::Aligned">Aligned</a>> !<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section><section id="impl-Sync-for-Ptr%3C'a,+A%3E" class="impl"><a href="#impl-Sync-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A = <a class="struct" href="struct.Aligned.html" title="struct bevy_ptr::Aligned">Aligned</a>> !<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A></h3></section><section id="impl-Unpin-for-Ptr%3C'a,+A%3E" class="impl"><a href="#impl-Unpin-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A><div class="where">where
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-Ptr%3C'a,+A%3E" class="impl"><a href="#impl-UnwindSafe-for-Ptr%3C'a,+A%3E" class="anchor">§</a><h3 class="code-header">impl<'a, A> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Ptr.html" title="struct bevy_ptr::Ptr">Ptr</a><'a, A><div class="where">where
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#273">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#275">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |