summaryrefslogtreecommitdiffstats
path: root/vendor/icu_provider/src/serde/mod.rs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:18:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:18:21 +0000
commit4e8199b572f2035b7749cba276ece3a26630d23e (patch)
treef09feeed6a0fe39d027b1908aa63ea6b35e4b631 /vendor/icu_provider/src/serde/mod.rs
parentAdding upstream version 1.66.0+dfsg1. (diff)
downloadrustc-4e8199b572f2035b7749cba276ece3a26630d23e.tar.xz
rustc-4e8199b572f2035b7749cba276ece3a26630d23e.zip
Adding upstream version 1.67.1+dfsg1.upstream/1.67.1+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/icu_provider/src/serde/mod.rs')
-rw-r--r--vendor/icu_provider/src/serde/mod.rs187
1 files changed, 187 insertions, 0 deletions
diff --git a/vendor/icu_provider/src/serde/mod.rs b/vendor/icu_provider/src/serde/mod.rs
new file mode 100644
index 000000000..d32148f02
--- /dev/null
+++ b/vendor/icu_provider/src/serde/mod.rs
@@ -0,0 +1,187 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+//! Provides the [`DeserializingBufferProvider`] wrapper, which deserializes data using Serde.
+//!
+//! Providers that produce opaque buffers that need to be deserialized into concrete data structs,
+//! such as `FsDataProvider`, should implement [`BufferProvider`]. These can be converted into
+//! [`DeserializingBufferProvider`] using the [`as_deserializing`](AsDeserializingBufferProvider::as_deserializing)
+//! convenience method.
+//!
+//! [`BufferProvider`]: crate::buf::BufferProvider
+
+// Hidden for now, but could be made public-stable in the future.
+#[doc(hidden)]
+pub mod borrow_de_utils;
+
+use crate::buf::BufferFormat;
+use crate::buf::BufferProvider;
+use crate::prelude::*;
+use serde::de::Deserialize;
+use yoke::trait_hack::YokeTraitHack;
+use yoke::Yokeable;
+
+/// A [`BufferProvider`] that deserializes its data using Serde.
+pub struct DeserializingBufferProvider<'a, P: ?Sized>(&'a P);
+
+/// Blanket-implemented trait adding the [`Self::as_deserializing()`] function.
+pub trait AsDeserializingBufferProvider {
+ /// Wrap this [`BufferProvider`] in a [`DeserializingBufferProvider`].
+ fn as_deserializing(&self) -> DeserializingBufferProvider<Self>;
+}
+
+impl<P> AsDeserializingBufferProvider for P
+where
+ P: BufferProvider + ?Sized,
+{
+ /// Wrap this [`BufferProvider`] in a [`DeserializingBufferProvider`].
+ fn as_deserializing(&self) -> DeserializingBufferProvider<Self> {
+ DeserializingBufferProvider(self)
+ }
+}
+
+fn deserialize_impl<'data, M>(
+ // Allow `bytes` to be unused in case all buffer formats are disabled
+ #[allow(unused_variables)] bytes: &'data [u8],
+ buffer_format: BufferFormat,
+) -> Result<<M::Yokeable as Yokeable<'data>>::Output, DataError>
+where
+ M: DataMarker,
+ // Actual bound:
+ // for<'de> <M::Yokeable as Yokeable<'de>>::Output: Deserialize<'de>,
+ // Necessary workaround bound (see `yoke::trait_hack` docs):
+ for<'de> YokeTraitHack<<M::Yokeable as Yokeable<'de>>::Output>: Deserialize<'de>,
+{
+ match buffer_format {
+ #[cfg(feature = "deserialize_json")]
+ BufferFormat::Json => {
+ let mut d = serde_json::Deserializer::from_slice(bytes);
+ let data = YokeTraitHack::<<M::Yokeable as Yokeable>::Output>::deserialize(&mut d)?;
+ Ok(data.0)
+ }
+
+ #[cfg(feature = "deserialize_bincode_1")]
+ BufferFormat::Bincode1 => {
+ use bincode::Options;
+ let options = bincode::DefaultOptions::new()
+ .with_fixint_encoding()
+ .allow_trailing_bytes();
+ let mut d = bincode::de::Deserializer::from_slice(bytes, options);
+ let data = YokeTraitHack::<<M::Yokeable as Yokeable>::Output>::deserialize(&mut d)?;
+ Ok(data.0)
+ }
+
+ #[cfg(feature = "deserialize_postcard_1")]
+ BufferFormat::Postcard1 => {
+ let mut d = postcard::Deserializer::from_bytes(bytes);
+ let data = YokeTraitHack::<<M::Yokeable as Yokeable>::Output>::deserialize(&mut d)?;
+ Ok(data.0)
+ }
+
+ // Allowed for cases in which all features are enabled
+ #[allow(unreachable_patterns)]
+ _ => Err(DataErrorKind::UnavailableBufferFormat(buffer_format).into_error()),
+ }
+}
+
+impl DataPayload<BufferMarker> {
+ /// Deserialize a [`DataPayload`]`<`[`BufferMarker`]`>` into a [`DataPayload`] of a
+ /// specific concrete type.
+ ///
+ /// This function takes the buffer format as an argument. When a buffer payload is returned
+ /// from a data provider, the buffer format is stored in the [`DataResponseMetadata`].
+ ///
+ /// # Examples
+ ///
+ /// Requires the `deserialize_json` feature:
+ ///
+ /// ```
+ /// use icu_provider::buf::BufferFormat;
+ /// use icu_provider::hello_world::*;
+ /// use icu_provider::prelude::*;
+ ///
+ /// let buffer: &[u8] = b"{\"message\":\"Hallo Welt\"}";
+ ///
+ /// let buffer_payload = DataPayload::from_owned(buffer);
+ /// let payload: DataPayload<HelloWorldV1Marker> = buffer_payload
+ /// .into_deserialized(BufferFormat::Json)
+ /// .expect("Deserialization successful");
+ ///
+ /// assert_eq!(payload.get().message, "Hallo Welt");
+ /// ```
+ pub fn into_deserialized<M>(
+ self,
+ buffer_format: BufferFormat,
+ ) -> Result<DataPayload<M>, DataError>
+ where
+ M: DataMarker,
+ // Actual bound:
+ // for<'de> <M::Yokeable as Yokeable<'de>>::Output: Deserialize<'de>,
+ // Necessary workaround bound (see `yoke::trait_hack` docs):
+ for<'de> YokeTraitHack<<M::Yokeable as Yokeable<'de>>::Output>: Deserialize<'de>,
+ {
+ self.try_map_project(|bytes, _| deserialize_impl::<M>(bytes, buffer_format))
+ }
+}
+
+impl<P, M> DynamicDataProvider<M> for DeserializingBufferProvider<'_, P>
+where
+ M: DataMarker,
+ P: BufferProvider + ?Sized,
+ // Actual bound:
+ // for<'de> <M::Yokeable as Yokeable<'de>>::Output: serde::de::Deserialize<'de>,
+ // Necessary workaround bound (see `yoke::trait_hack` docs):
+ for<'de> YokeTraitHack<<M::Yokeable as Yokeable<'de>>::Output>: Deserialize<'de>,
+{
+ fn load_data(&self, key: DataKey, req: DataRequest) -> Result<DataResponse<M>, DataError> {
+ let buffer_response = BufferProvider::load_buffer(self.0, key, req)?;
+ let buffer_format = buffer_response
+ .metadata
+ .buffer_format
+ .ok_or_else(|| DataError::custom("BufferProvider didn't set BufferFormat"))?;
+ Ok(DataResponse {
+ metadata: buffer_response.metadata,
+ payload: buffer_response
+ .payload
+ .map(|p| p.into_deserialized(buffer_format))
+ .transpose()?,
+ })
+ }
+}
+
+impl<P, M> DataProvider<M> for DeserializingBufferProvider<'_, P>
+where
+ M: KeyedDataMarker,
+ P: BufferProvider + ?Sized,
+ // Actual bound:
+ // for<'de> <M::Yokeable as Yokeable<'de>>::Output: Deserialize<'de>,
+ // Necessary workaround bound (see `yoke::trait_hack` docs):
+ for<'de> YokeTraitHack<<M::Yokeable as Yokeable<'de>>::Output>: Deserialize<'de>,
+{
+ /// Converts a buffer into a concrete type by deserializing from a supported buffer format.
+ fn load(&self, req: DataRequest) -> Result<DataResponse<M>, DataError> {
+ self.load_data(M::KEY, req)
+ }
+}
+
+#[cfg(feature = "serde_json")]
+impl From<serde_json::error::Error> for crate::DataError {
+ fn from(e: serde_json::error::Error) -> Self {
+ crate::DataError::custom("JSON deserialize").with_display_context(&e)
+ }
+}
+
+#[cfg(feature = "bincode")]
+impl From<bincode::Error> for crate::DataError {
+ fn from(e: bincode::Error) -> Self {
+ crate::DataError::custom("Bincode deserialize").with_display_context(&e)
+ }
+}
+
+#[cfg(feature = "postcard")]
+impl From<postcard::Error> for crate::DataError {
+ fn from(e: postcard::Error) -> Self {
+ crate::DataError::custom("Postcard deserialize").with_display_context(&e)
+ }
+}