-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathtrait.Serialize.html
18 lines (18 loc) · 20.5 KB
/
trait.Serialize.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<!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 that can be serialized via `#[serde(with = "serde_bytes")]`."><title>Serialize in serde_bytes - 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-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="serde_bytes" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.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="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../serde_bytes/index.html">serde_<wbr>bytes</a><span class="version">0.11.17</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Serialize</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.serialize" title="serialize">serialize</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Serialize-for-%26T" title="&T">&T</a></li><li><a href="#impl-Serialize-for-Box%3CT%3E" title="Box<T>">Box<T></a></li><li><a href="#impl-Serialize-for-Cow%3C'a,+Bytes%3E" title="Cow<'a, Bytes>">Cow<'a, Bytes></a></li><li><a href="#impl-Serialize-for-Cow%3C'a,+%5Bu8%5D%3E" title="Cow<'a, [u8]>">Cow<'a, [u8]></a></li><li><a href="#impl-Serialize-for-Option%3CT%3E" title="Option<T>">Option<T></a></li><li><a href="#impl-Serialize-for-Vec%3Cu8%3E" title="Vec<u8>">Vec<u8></a></li><li><a href="#impl-Serialize-for-%5Bu8;+N%5D" title="[u8; N]">[u8; N]</a></li><li><a href="#impl-Serialize-for-%5Bu8%5D" title="[u8]">[u8]</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 serde_<wbr>bytes</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">serde_bytes</a></span><h1>Trait <span class="trait">Serialize</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/serde_bytes/ser.rs.html#19-24">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Serialize {
// Required method
fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>>
<span class="where">where S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a></span>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types that can be serialized via <code>#[serde(with = "serde_bytes")]</code>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.serialize" class="method"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#21-23">Source</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div><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.85.0/reference/items/traits.html#object-safety">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><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-Vec%3Cu8%3E" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#36-43">Source</a><a href="#impl-Serialize-for-Vec%3Cu8%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="struct" href="https://doc.rust-lang.org/1.85.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.u8.html">u8</a>></h3></section></summary><div class="impl-items"><section id="method.serialize" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#37-42">Source</a><a href="#method.serialize" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-%5Bu8%5D" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#26-33">Source</a><a href="#impl-Serialize-for-%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for [<a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.u8.html">u8</a>]</h3></section></summary><div class="impl-items"><section id="method.serialize-1" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#27-32">Source</a><a href="#method.serialize-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-Cow%3C'a,+Bytes%3E" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#93-100">Source</a><a href="#impl-Serialize-for-Cow%3C'a,+Bytes%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="enum" href="https://doc.rust-lang.org/1.85.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, <a class="struct" href="struct.Bytes.html" title="struct serde_bytes::Bytes">Bytes</a>></h3></section></summary><div class="impl-items"><section id="method.serialize-2" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#94-99">Source</a><a href="#method.serialize-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-Cow%3C'a,+%5Bu8%5D%3E" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#83-90">Source</a><a href="#impl-Serialize-for-Cow%3C'a,+%5Bu8%5D%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="enum" href="https://doc.rust-lang.org/1.85.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, [<a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.u8.html">u8</a>]></h3></section></summary><div class="impl-items"><section id="method.serialize-3" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#84-89">Source</a><a href="#method.serialize-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-Option%3CT%3E" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#127-154">Source</a><a href="#impl-Serialize-for-Option%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T><div class="where">where
T: <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a>,</div></h3></section></summary><div class="impl-items"><section id="method.serialize-4" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#131-153">Source</a><a href="#method.serialize-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-%26T" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#102-112">Source</a><a href="#impl-Serialize-for-%26T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.reference.html">&T</a><div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.85.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a>,</div></h3></section></summary><div class="impl-items"><section id="method.serialize-5" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#106-111">Source</a><a href="#method.serialize-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#115-125">Source</a><a href="#impl-Serialize-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="struct" href="https://doc.rust-lang.org/1.85.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T><div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.85.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a>,</div></h3></section></summary><div class="impl-items"><section id="method.serialize-6" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#119-124">Source</a><a href="#method.serialize-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-%5Bu8;+N%5D" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#54-61">Source</a><a href="#impl-Serialize-for-%5Bu8;+N%5D" class="anchor">§</a><h3 class="code-header">impl<const N: <a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for [<a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.u8.html">u8</a>; <a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.array.html">N</a>]</h3></section></summary><div class="impl-items"><section id="method.serialize-7" class="method trait-impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#55-60">Source</a><a href="#method.serialize-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></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-Serialize-for-ByteBuf" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#73-80">Source</a><a href="#impl-Serialize-for-ByteBuf" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="struct" href="struct.ByteBuf.html" title="struct serde_bytes::ByteBuf">ByteBuf</a></h3></section><section id="impl-Serialize-for-Bytes" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#45-52">Source</a><a href="#impl-Serialize-for-Bytes" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="struct" href="struct.Bytes.html" title="struct serde_bytes::Bytes">Bytes</a></h3></section><section id="impl-Serialize-for-ByteArray%3CN%3E" class="impl"><a class="src rightside" href="../src/serde_bytes/ser.rs.html#63-70">Source</a><a href="#impl-Serialize-for-ByteArray%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<const N: <a class="primitive" href="https://doc.rust-lang.org/1.85.0/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.Serialize.html" title="trait serde_bytes::Serialize">Serialize</a> for <a class="struct" href="struct.ByteArray.html" title="struct serde_bytes::ByteArray">ByteArray</a><N></h3></section></div><script src="../trait.impl/serde_bytes/ser/trait.Serialize.js" data-ignore-extern-crates="std,alloc,core" async></script></section></div></main></body></html>