mirror of
https://github.com/esp-rs/esp-idf-hal.git
synced 2025-12-30 05:01:44 +00:00
11 lines
5.8 KiB
HTML
11 lines
5.8 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="An `EnumSetType` for which `EnumSet`s have a guaranteed in-memory representation."><title>EnumSetTypeWithRepr in enumset - 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="enumset" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (8361aef0d 2025-01-14)" data-channel="nightly" 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="../enumset/index.html">enumset</a><span class="version">1.1.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Enum<wbr>SetType<wbr>With<wbr>Repr</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Repr" title="Repr">Repr</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 enumset</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">enumset</a></span><h1>Trait <span class="trait">EnumSetTypeWithRepr</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/enumset/traits.rs.html#28-33">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait EnumSetTypeWithRepr: <a class="trait" href="trait.EnumSetType.html" title="trait enumset::EnumSetType">EnumSetType</a> + EnumSetTypePrivate<Repr = Self::<a class="associatedtype" href="trait.EnumSetTypeWithRepr.html#associatedtype.Repr" title="type enumset::EnumSetTypeWithRepr::Repr">Repr</a>> {
|
|
type <a href="#associatedtype.Repr" class="associatedtype">Repr</a>: EnumSetTypeRepr;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An <a href="trait.EnumSetType.html" title="trait enumset::EnumSetType"><code>EnumSetType</code></a> for which <a href="struct.EnumSet.html" title="struct enumset::EnumSet"><code>EnumSet</code></a>s have a guaranteed in-memory representation.</p>
|
|
<p>An implementation of this trait is generated by using
|
|
<a href="derive.EnumSetType.html" title="derive enumset::EnumSetType"><code>#[derive(EnumSetType)]</code></a> with the annotation
|
|
<code>#[enumset(repr = "…")]</code>, where <code>…</code> is <code>u8</code>, <code>u16</code>, <code>u32</code>, <code>u64</code> or <code>u128</code>.</p>
|
|
<p>For any type <code>T</code> that implements this trait, the in-memory representation of <code>EnumSet<T></code>
|
|
is guaranteed to be <code>Repr</code>. This guarantee is useful for FFI. See <a href="struct.EnumSet.html#ffi-safety-and-repr" title="struct enumset::EnumSet">the <code>EnumSet</code> documentation
|
|
under “FFI, Safety and <code>repr</code>”</a> for an example.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Repr" class="method"><a class="src rightside" href="../src/enumset/traits.rs.html#32">Source</a><h4 class="code-header">type <a href="#associatedtype.Repr" class="associatedtype">Repr</a>: EnumSetTypeRepr</h4></section></summary><div class="docblock"><p>The guaranteed representation.</p>
|
|
</div></details></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/nightly/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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/enumset/traits/trait.EnumSetTypeWithRepr.js" async></script></section></div></main></body></html> |