35 lines
10 KiB
HTML
35 lines
10 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="Trait marker for data structs. All types delivered by the data provider must be associated with something implementing this trait."><title>DynamicDataMarker in icu_provider - 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="icu_provider" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" 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="#">DynamicDataMarker</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../icu_provider/index.html">icu_<wbr>provider</a><span class="version">2.1.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Dynamic<wbr>Data<wbr>Marker</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.DataStruct" title="DataStruct">DataStruct</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 icu_<wbr>provider</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">icu_provider</a></div><h1>Trait <span class="trait">Dynamic<wbr>Data<wbr>Marker</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/icu_provider/marker.rs.html#52-56">Source</a> </span></div><pre class="rust item-decl"><code>pub trait DynamicDataMarker: 'static {
|
|
type <a href="#associatedtype.DataStruct" class="associatedtype">DataStruct</a>: for<'a> <a class="trait" href="../yoke/yokeable/trait.Yokeable.html" title="trait yoke::yokeable::Yokeable">Yokeable</a><'a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait marker for data structs. All types delivered by the data provider must be associated with
|
|
something implementing this trait.</p>
|
|
<p>Data markers normally generated with the <a href="macro.data_marker.html" title="macro icu_provider::data_marker"><code>data_marker</code></a> macro.</p>
|
|
<p>Also see <a href="trait.DataMarker.html" title="trait icu_provider::DataMarker"><code>DataMarker</code></a>.</p>
|
|
<p>Note: <code>DynamicDataMarker</code>s are quasi-const-generic compile-time objects, and as such are expected
|
|
to be unit structs. As this is not something that can be enforced by the type system, we
|
|
currently only have a <code>'static</code> bound on them (which is needed by a lot of our code).</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Manually implementing DynamicDataMarker for a custom type:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>icu_provider::prelude::<span class="kw-2">*</span>;
|
|
<span class="kw">use </span>std::borrow::Cow;
|
|
|
|
<span class="attr">#[derive(yoke::Yokeable, zerofrom::ZeroFrom)]
|
|
</span><span class="kw">struct </span>MyDataStruct<<span class="lifetime">'data</span>> {
|
|
message: Cow<<span class="lifetime">'data</span>, str>,
|
|
}
|
|
|
|
<span class="kw">struct </span>MyDataStructMarker;
|
|
|
|
<span class="kw">impl </span>DynamicDataMarker <span class="kw">for </span>MyDataStructMarker {
|
|
<span class="kw">type </span>DataStruct = MyDataStruct<<span class="lifetime">'static</span>>;
|
|
}
|
|
|
|
<span class="comment">// We can now use MyDataStruct with DataProvider:
|
|
</span><span class="kw">let </span>s = MyDataStruct {
|
|
message: Cow::Owned(<span class="string">"Hello World"</span>.into()),
|
|
};
|
|
<span class="kw">let </span>payload = DataPayload::<MyDataStructMarker>::from_owned(s);
|
|
<span class="macro">assert_eq!</span>(payload.get().message, <span class="string">"Hello World"</span>);</code></pre></div></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.DataStruct" class="method"><a class="src rightside" href="../src/icu_provider/marker.rs.html#55">Source</a><h4 class="code-header">type <a href="#associatedtype.DataStruct" class="associatedtype">DataStruct</a>: for<'a> <a class="trait" href="../yoke/yokeable/trait.Yokeable.html" title="trait yoke::yokeable::Yokeable">Yokeable</a><'a></h4></section></summary><div class="docblock"><p>A type that implements <a href="../yoke/yokeable/trait.Yokeable.html" title="trait yoke::yokeable::Yokeable"><code>Yokeable</code></a>. This should typically be the <code>'static</code> version of a
|
|
data struct.</p>
|
|
</div></details></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-DynamicDataMarker-for-BufferMarker" class="impl"><a class="src rightside" href="../src/icu_provider/buf.rs.html#22-24">Source</a><a href="#impl-DynamicDataMarker-for-BufferMarker" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynamicDataMarker.html" title="trait icu_provider::DynamicDataMarker">DynamicDataMarker</a> for <a class="struct" href="buf/struct.BufferMarker.html" title="struct icu_provider::buf::BufferMarker">BufferMarker</a></h3></section></summary><div class="impl-items"><section id="associatedtype.DataStruct-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/icu_provider/buf.rs.html#23">Source</a><a href="#associatedtype.DataStruct-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.DataStruct" class="associatedtype">DataStruct</a> = &'static [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-DynamicDataMarker-for-ErasedMarker%3CDataStruct%3E" class="impl"><a class="src rightside" href="../src/icu_provider/marker.rs.html#608-610">Source</a><a href="#impl-DynamicDataMarker-for-ErasedMarker%3CDataStruct%3E" class="anchor">§</a><h3 class="code-header">impl<DataStruct: for<'a> <a class="trait" href="../yoke/yokeable/trait.Yokeable.html" title="trait yoke::yokeable::Yokeable">Yokeable</a><'a>> <a class="trait" href="trait.DynamicDataMarker.html" title="trait icu_provider::DynamicDataMarker">DynamicDataMarker</a> for <a class="struct" href="marker/struct.ErasedMarker.html" title="struct icu_provider::marker::ErasedMarker">ErasedMarker</a><DataStruct></h3></section></summary><div class="impl-items"><section id="associatedtype.DataStruct-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/icu_provider/marker.rs.html#609">Source</a><a href="#associatedtype.DataStruct-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.DataStruct" class="associatedtype">DataStruct</a> = DataStruct</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-DynamicDataMarker-for-NeverMarker%3CY%3E" class="impl"><a class="src rightside" href="../src/icu_provider/marker.rs.html#141-146">Source</a><a href="#impl-DynamicDataMarker-for-NeverMarker%3CY%3E" class="anchor">§</a><h3 class="code-header">impl<Y> <a class="trait" href="trait.DynamicDataMarker.html" title="trait icu_provider::DynamicDataMarker">DynamicDataMarker</a> for <a class="struct" href="marker/struct.NeverMarker.html" title="struct icu_provider::marker::NeverMarker">NeverMarker</a><Y><div class="where">where
|
|
for<'a> Y: <a class="trait" href="../yoke/yokeable/trait.Yokeable.html" title="trait yoke::yokeable::Yokeable">Yokeable</a><'a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.DataStruct-3" class="associatedtype trait-impl"><a class="src rightside" href="../src/icu_provider/marker.rs.html#145">Source</a><a href="#associatedtype.DataStruct-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.DataStruct" class="associatedtype">DataStruct</a> = Y</h4></section></div></details></div><script src="../trait.impl/icu_provider/marker_full/trait.DynamicDataMarker.js" async></script></section></div></main></body></html> |