34 lines
5.1 KiB
HTML
34 lines
5.1 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="Derives `CheckBytes` for the labeled type."><title>CheckBytes in bytecheck_derive - 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="bytecheck_derive" 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="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 derive"><!--[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="../bytecheck_derive/index.html">bytecheck_<wbr>derive</a><span class="version">0.8.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Check<wbr>Bytes</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#attributes" title="Attributes">Attributes</a><ul><li><a href="#types-only" title="Types only">Types only</a></li><li><a href="#fields-only" title="Fields only">Fields only</a></li></ul></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bytecheck_<wbr>derive</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">bytecheck_derive</a></span><h1>Derive Macro <span class="derive">CheckBytes</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/bytecheck_derive/lib.rs.html#62-69">Source</a> </span></div><pre class="rust item-decl"><code>#[derive(CheckBytes)]
|
|
{
|
|
<span class="comment">// Attributes available to this derive:</span>
|
|
#[bytecheck]
|
|
}
|
|
</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Derives <code>CheckBytes</code> for the labeled type.</p>
|
|
<p>This derive macro automatically adds a type bound <code>field: CheckBytes<__C></code>
|
|
for each field type. This can cause an overflow while evaluating trait
|
|
bounds if the structure eventually references its own type, as the
|
|
implementation of <code>CheckBytes</code> for a struct depends on each field type
|
|
implementing it as well. Adding the attribute <code>#[check_bytes(omit_bounds)]</code>
|
|
to a field will suppress this trait bound and allow recursive structures.
|
|
This may be too coarse for some types, in which case additional type bounds
|
|
may be required with <code>bounds(...)</code>.</p>
|
|
<h2 id="attributes"><a class="doc-anchor" href="#attributes">§</a>Attributes</h2>
|
|
<p>Additional arguments can be specified using attributes.</p>
|
|
<p><code>#[bytecheck(...)]</code> accepts the following attributes:</p>
|
|
<h3 id="types-only"><a class="doc-anchor" href="#types-only">§</a>Types only</h3>
|
|
<ul>
|
|
<li><code>bounds(...)</code>: Adds additional bounds to the <code>CheckBytes</code> implementation.
|
|
This can be especially useful when dealing with recursive structures,
|
|
where bounds may need to be omitted to prevent recursive type definitions.
|
|
In the context of the added bounds, <code>__C</code> is the name of the context
|
|
generic (e.g. <code>__C: MyContext</code>).</li>
|
|
<li><code>crate = ...</code>: Chooses an alternative crate path to import bytecheck from.</li>
|
|
<li><code>verify</code>: Adds an additional verification step after the validity of each
|
|
field has been checked. See the <code>Verify</code> trait for more information.</li>
|
|
</ul>
|
|
<h3 id="fields-only"><a class="doc-anchor" href="#fields-only">§</a>Fields only</h3>
|
|
<ul>
|
|
<li><code>omit_bounds</code>: Omits trait bounds for the annotated field in the generated
|
|
impl.</li>
|
|
</ul>
|
|
</div></details></section></div></main></body></html> |