Files
phy/rkyv/trait.SerializeUnsized.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

26 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="A counterpart of `Serialize` thats suitable for unsized types."><title>SerializeUnsized in rkyv - 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="rkyv" 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="
data:image/svg+xml,%3Csvg xmlns=&#39;http://www.w3.org/2000/svg&#39; viewBox=&#39;0 0
26.458 26.458&#39;%3E%3Cpath d=&#39;M0 0v26.458h26.458V0zm9.175 3.772l8.107 8.106
2.702-2.702 2.702 13.512-13.512-2.702 2.703-2.702-8.107-8.107z&#39;/%3E
%3C/svg%3E
"></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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../rkyv/index.html"><img src="
data:image/svg+xml,%3Csvg xmlns=&#34;http://www.w3.org/2000/svg&#34; width=&#34;100&#34;
height=&#34;100&#34; viewBox=&#34;0 0 26.458 26.458&#34;%3E%3Cpath d=&#34;M0
0v26.458h26.458V0zm9.175 3.772l8.107 8.106 2.702-2.702 2.702
13.512-13.512-2.702 2.703-2.702-8.107-8.107z&#34;/%3E%3C/svg%3E
" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../rkyv/index.html"><img src="
data:image/svg+xml,%3Csvg xmlns=&#34;http://www.w3.org/2000/svg&#34; width=&#34;100&#34;
height=&#34;100&#34; viewBox=&#34;0 0 26.458 26.458&#34;%3E%3Cpath d=&#34;M0
0v26.458h26.458V0zm9.175 3.772l8.107 8.106 2.702-2.702 2.702
13.512-13.512-2.702 2.703-2.702-8.107-8.107z&#34;/%3E%3C/svg%3E
" alt="logo"></a><h2><a href="../rkyv/index.html">rkyv</a><span class="version">0.8.8</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Serialize<wbr>Unsized</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.serialize_unsized" title="serialize_unsized">serialize_unsized</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SerializeUnsized%3CS%3E-for-CStr" title="CStr">CStr</a></li><li><a href="#impl-SerializeUnsized%3CS%3E-for-%5BT%5D" title="[T]">[T]</a></li><li><a href="#impl-SerializeUnsized%3CS%3E-for-str" title="str">str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rkyv</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">rkyv</a></span><h1>Trait <span class="trait">SerializeUnsized</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/rkyv/traits.rs.html#460-463">Source</a> </span></div><pre class="rust item-decl"><code>pub trait SerializeUnsized&lt;S: <a class="trait" href="../rancor/trait.Fallible.html" title="trait rancor::Fallible">Fallible</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt;: <a class="trait" href="trait.ArchiveUnsized.html" title="trait rkyv::ArchiveUnsized">ArchiveUnsized</a> {
// Required method
fn <a href="#tymethod.serialize_unsized" class="fn">serialize_unsized</a>(&amp;self, serializer: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut S</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, S::<a class="associatedtype" href="../rancor/trait.Fallible.html#associatedtype.Error" title="type rancor::Fallible::Error">Error</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A counterpart of <a href="trait.Serialize.html" title="trait rkyv::Serialize"><code>Serialize</code></a> thats suitable for unsized types.</p>
<p>See <a href="trait.ArchiveUnsized.html" title="trait rkyv::ArchiveUnsized"><code>ArchiveUnsized</code></a> for examples of implementing <code>SerializeUnsized</code>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.serialize_unsized" class="method"><a class="src rightside" href="../src/rkyv/traits.rs.html#462">Source</a><h4 class="code-header">fn <a href="#tymethod.serialize_unsized" class="fn">serialize_unsized</a>(&amp;self, serializer: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut S</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, S::<a class="associatedtype" href="../rancor/trait.Fallible.html#associatedtype.Error" title="type rancor::Fallible::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Writes the object and returns the position of the archived type.</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-SerializeUnsized%3CS%3E-for-str" class="impl"><a class="src rightside" href="../src/rkyv/impls/core/mod.rs.html#389-395">Source</a><a href="#impl-SerializeUnsized%3CS%3E-for-str" class="anchor">§</a><h3 class="code-header">impl&lt;S: <a class="trait" href="../rancor/trait.Fallible.html" title="trait rancor::Fallible">Fallible</a> + <a class="trait" href="ser/trait.Writer.html" title="trait rkyv::ser::Writer">Writer</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.SerializeUnsized.html" title="trait rkyv::SerializeUnsized">SerializeUnsized</a>&lt;S&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><section id="method.serialize_unsized" class="method trait-impl"><a class="src rightside" href="../src/rkyv/impls/core/mod.rs.html#390-394">Source</a><a href="#method.serialize_unsized" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize_unsized" class="fn">serialize_unsized</a>(&amp;self, serializer: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut S</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, S::<a class="associatedtype" href="../rancor/trait.Fallible.html#associatedtype.Error" title="type rancor::Fallible::Error">Error</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-SerializeUnsized%3CS%3E-for-CStr" class="impl"><a class="src rightside" href="../src/rkyv/impls/core/ffi.rs.html#53-59">Source</a><a href="#impl-SerializeUnsized%3CS%3E-for-CStr" class="anchor">§</a><h3 class="code-header">impl&lt;S: <a class="trait" href="../rancor/trait.Fallible.html" title="trait rancor::Fallible">Fallible</a> + <a class="trait" href="ser/trait.Writer.html" title="trait rkyv::ser::Writer">Writer</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.SerializeUnsized.html" title="trait rkyv::SerializeUnsized">SerializeUnsized</a>&lt;S&gt; for <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/ffi/c_str/struct.CStr.html" title="struct core::ffi::c_str::CStr">CStr</a></h3></section></summary><div class="impl-items"><section id="method.serialize_unsized-1" class="method trait-impl"><a class="src rightside" href="../src/rkyv/impls/core/ffi.rs.html#54-58">Source</a><a href="#method.serialize_unsized-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize_unsized" class="fn">serialize_unsized</a>(&amp;self, serializer: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut S</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, S::<a class="associatedtype" href="../rancor/trait.Fallible.html#associatedtype.Error" title="type rancor::Fallible::Error">Error</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-SerializeUnsized%3CS%3E-for-%5BT%5D" class="impl"><a class="src rightside" href="../src/rkyv/impls/core/mod.rs.html#283-328">Source</a><a href="#impl-SerializeUnsized%3CS%3E-for-%5BT%5D" class="anchor">§</a><h3 class="code-header">impl&lt;T, S&gt; <a class="trait" href="trait.SerializeUnsized.html" title="trait rkyv::SerializeUnsized">SerializeUnsized</a>&lt;S&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.slice.html">[T]</a><div class="where">where
T: <a class="trait" href="trait.Serialize.html" title="trait rkyv::Serialize">Serialize</a>&lt;S&gt;,
S: <a class="trait" href="../rancor/trait.Fallible.html" title="trait rancor::Fallible">Fallible</a> + <a class="trait" href="ser/trait.Allocator.html" title="trait rkyv::ser::Allocator">Allocator</a> + <a class="trait" href="ser/trait.Writer.html" title="trait rkyv::ser::Writer">Writer</a> + ?<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"><section id="method.serialize_unsized-2" class="method trait-impl"><a class="src rightside" href="../src/rkyv/impls/core/mod.rs.html#288-327">Source</a><a href="#method.serialize_unsized-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize_unsized" class="fn">serialize_unsized</a>(&amp;self, serializer: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut S</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, S::<a class="associatedtype" href="../rancor/trait.Fallible.html#associatedtype.Error" title="type rancor::Fallible::Error">Error</a>&gt;</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SerializeUnsized%3CS%3E-for-T" class="impl"><a class="src rightside" href="../src/rkyv/impls/core/mod.rs.html#70-80">Source</a><a href="#impl-SerializeUnsized%3CS%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, S&gt; <a class="trait" href="trait.SerializeUnsized.html" title="trait rkyv::SerializeUnsized">SerializeUnsized</a>&lt;S&gt; for T<div class="where">where
T: <a class="trait" href="trait.Serialize.html" title="trait rkyv::Serialize">Serialize</a>&lt;S&gt;,
S: <a class="trait" href="../rancor/trait.Fallible.html" title="trait rancor::Fallible">Fallible</a> + <a class="trait" href="ser/trait.Writer.html" title="trait rkyv::ser::Writer">Writer</a> + ?<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></div><script src="../trait.impl/rkyv/traits/trait.SerializeUnsized.js" data-ignore-extern-crates="core,std" async></script></section></div></main></body></html>