60 lines
7.6 KiB
HTML
60 lines
7.6 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="A data provider that returns opaque bytes."><title>BufferProvider in icu_provider::buf - 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="#">BufferProvider</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="#">Buffer<wbr>Provider</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="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In icu_<wbr>provider::<wbr>buf</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>::<wbr><a href="index.html">buf</a></div><h1>Trait <span class="trait">Buffer<wbr>Provider</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/buf.rs.html#96">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BufferProvider: <a class="trait" href="../trait.DynamicDataProvider.html" title="trait icu_provider::DynamicDataProvider">DynamicDataProvider</a><<a class="struct" href="struct.BufferMarker.html" title="struct icu_provider::buf::BufferMarker">BufferMarker</a>> { }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A data provider that returns opaque bytes.</p>
|
|
<p>Generally, these bytes are expected to be deserializable with Serde. To get an object
|
|
implementing <a href="../trait.DataProvider.html" title="trait icu_provider::DataProvider"><code>DataProvider</code></a> via Serde, use <a href="AsDeserializingBufferProvider::as_deserializing"><code>as_deserializing()</code></a>.</p>
|
|
<p>Passing a <code>BufferProvider</code> to a <code>*_with_buffer_provider</code> constructor requires enabling
|
|
the deserialization Cargo feature for the expected format(s):</p>
|
|
<ul>
|
|
<li><code>deserialize_json</code></li>
|
|
<li><code>deserialize_postcard_1</code></li>
|
|
<li><code>deserialize_bincode_1</code></li>
|
|
</ul>
|
|
<p>Along with <a href="../trait.DataProvider.html" title="trait icu_provider::DataProvider"><code>DataProvider</code></a>, this is one of the two foundational traits in this crate.</p>
|
|
<p><a href="trait.BufferProvider.html" title="trait icu_provider::buf::BufferProvider"><code>BufferProvider</code></a> can be made into a trait object. It is used over FFI.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>icu_locale_core::langid;
|
|
<span class="kw">use </span>icu_provider::hello_world::<span class="kw-2">*</span>;
|
|
<span class="kw">use </span>icu_provider::prelude::<span class="kw-2">*</span>;
|
|
<span class="kw">use </span>std::borrow::Cow;
|
|
|
|
<span class="kw">let </span>buffer_provider = HelloWorldProvider.into_json_provider();
|
|
|
|
<span class="comment">// Deserializing manually
|
|
</span><span class="macro">assert_eq!</span>(
|
|
serde_json::from_slice::<HelloWorld>(
|
|
buffer_provider
|
|
.load_data(
|
|
HelloWorldV1::INFO,
|
|
DataRequest {
|
|
id: DataIdentifierBorrowed::for_locale(
|
|
<span class="kw-2">&</span><span class="macro">langid!</span>(<span class="string">"de"</span>).into()
|
|
),
|
|
..Default::default()
|
|
}
|
|
)
|
|
.expect(<span class="string">"load should succeed"</span>)
|
|
.payload
|
|
.get()
|
|
)
|
|
.expect(<span class="string">"should deserialize"</span>),
|
|
HelloWorld {
|
|
message: Cow::Borrowed(<span class="string">"Hallo Welt"</span>),
|
|
},
|
|
);
|
|
|
|
<span class="comment">// Deserialize automatically
|
|
</span><span class="kw">let </span>deserializing_provider: <span class="kw-2">&</span><span class="kw">dyn </span>DataProvider<HelloWorldV1> =
|
|
<span class="kw-2">&</span>buffer_provider.as_deserializing();
|
|
|
|
<span class="macro">assert_eq!</span>(
|
|
deserializing_provider
|
|
.load(DataRequest {
|
|
id: DataIdentifierBorrowed::for_locale(<span class="kw-2">&</span><span class="macro">langid!</span>(<span class="string">"de"</span>).into()),
|
|
..Default::default()
|
|
})
|
|
.expect(<span class="string">"load should succeed"</span>)
|
|
.payload
|
|
.get(),
|
|
<span class="kw-2">&</span>HelloWorld {
|
|
message: Cow::Borrowed(<span class="string">"Hallo Welt"</span>),
|
|
},
|
|
);</code></pre></div></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-BufferProvider-for-P" class="impl"><a class="src rightside" href="../../src/icu_provider/buf.rs.html#98">Source</a><a href="#impl-BufferProvider-for-P" class="anchor">§</a><h3 class="code-header">impl<P: <a class="trait" href="../trait.DynamicDataProvider.html" title="trait icu_provider::DynamicDataProvider">DynamicDataProvider</a><<a class="struct" href="struct.BufferMarker.html" title="struct icu_provider::buf::BufferMarker">BufferMarker</a>> + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.BufferProvider.html" title="trait icu_provider::buf::BufferProvider">BufferProvider</a> for P</h3></section></div><script src="../../trait.impl/icu_provider/buf/trait.BufferProvider.js" async></script></section></div></main></body></html> |