blob: f45e5c0ef1cfbfb378e8f28484a95da92cc10471 [file] [log] [blame] [edit]
<!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="API documentation for the Rust `Message` trait in crate `proc_macro_api`."><title>Message in proc_macro_api::legacy_protocol::msg - 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="proc_macro_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11)" 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="#">Message</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../proc_macro_api/index.html">proc_<wbr>macro_<wbr>api</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Message</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Buf" title="Buf">Buf</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.read" title="read">read</a></li><li><a href="#tymethod.write" title="write">write</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><a href="index.html">In proc_<wbr>macro_<wbr>api::<wbr>legacy_<wbr>protocol::<wbr>msg</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">proc_macro_api</a>::<wbr><a href="../index.html">legacy_protocol</a>::<wbr><a href="index.html">msg</a></div><h1>Trait <span class="trait">Message</span>&nbsp;<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/proc_macro_api/legacy_protocol/msg.rs.html#157-161">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Message: <a class="trait" href="https://docs.rs/serde_core/1.0.226/serde_core/ser/trait.Serialize.html" title="trait serde_core::ser::Serialize">Serialize</a> + <a class="trait" href="https://docs.rs/serde_core/1.0.226/serde_core/de/trait.DeserializeOwned.html" title="trait serde_core::de::DeserializeOwned">DeserializeOwned</a> {
type <a href="#associatedtype.Buf" class="associatedtype">Buf</a>;
// Required methods
fn <a href="#tymethod.read" class="fn">read</a>(inp: &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/io/trait.BufRead.html" title="trait std::io::BufRead">BufRead</a>, buf: &amp;mut Self::<a class="associatedtype" href="trait.Message.html#associatedtype.Buf" title="type proc_macro_api::legacy_protocol::msg::Message::Buf">Buf</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.write" class="fn">write</a>(self, out: &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>&gt;;
}</code></pre><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Buf" class="method"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#158">Source</a><h4 class="code-header">type <a href="#associatedtype.Buf" class="associatedtype">Buf</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.read" class="method"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#159">Source</a><h4 class="code-header">fn <a href="#tymethod.read" class="fn">read</a>(inp: &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/io/trait.BufRead.html" title="trait std::io::BufRead">BufRead</a>, buf: &amp;mut Self::<a class="associatedtype" href="trait.Message.html#associatedtype.Buf" title="type proc_macro_api::legacy_protocol::msg::Message::Buf">Buf</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;&gt;</h4></section><section id="tymethod.write" class="method"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#160">Source</a><h4 class="code-header">fn <a href="#tymethod.write" class="fn">write</a>(self, out: &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>&gt;</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.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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-Message-for-BidirectionalMessage" class="impl"><a class="src rightside" href="../../../src/proc_macro_api/bidirectional_protocol/msg.rs.html#107-120">Source</a><a href="#impl-Message-for-BidirectionalMessage" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Message.html" title="trait proc_macro_api::legacy_protocol::msg::Message">Message</a> for <a class="enum" href="../../bidirectional_protocol/msg/enum.BidirectionalMessage.html" title="enum proc_macro_api::bidirectional_protocol::msg::BidirectionalMessage">BidirectionalMessage</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Buf-1" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/proc_macro_api/bidirectional_protocol/msg.rs.html#108">Source</a><a href="#associatedtype.Buf-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Buf" class="associatedtype">Buf</a> = <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Message-for-Request" class="impl"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#163-176">Source</a><a href="#impl-Message-for-Request" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Message.html" title="trait proc_macro_api::legacy_protocol::msg::Message">Message</a> for <a class="enum" href="enum.Request.html" title="enum proc_macro_api::legacy_protocol::msg::Request">Request</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Buf-2" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#164">Source</a><a href="#associatedtype.Buf-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Buf" class="associatedtype">Buf</a> = <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Message-for-Response" class="impl"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#178-191">Source</a><a href="#impl-Message-for-Response" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Message.html" title="trait proc_macro_api::legacy_protocol::msg::Message">Message</a> for <a class="enum" href="enum.Response.html" title="enum proc_macro_api::legacy_protocol::msg::Response">Response</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Buf-3" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/proc_macro_api/legacy_protocol/msg.rs.html#179">Source</a><a href="#associatedtype.Buf-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Buf" class="associatedtype">Buf</a> = <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></div></details></div><script src="../../../trait.impl/proc_macro_api/legacy_protocol/msg/trait.Message.js" async></script></section></div></main></body></html>