forked from unicode-org/icu4x
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename AnyPayloadProvider to FixedProvider, make it generic (unicode-…
…org#5502) Part 1 of unicode-org#3947 not yet planning on doing part 2 <!-- Thank you for your pull request to ICU4X! Reminder: try to use [Conventional Comments](https://conventionalcomments.org/) to make comments clearer. Please see https://github.com/unicode-org/icu4x/blob/main/CONTRIBUTING.md for general information on contributing to ICU4X. -->
- Loading branch information
1 parent
e266337
commit b7d567f
Showing
14 changed files
with
193 additions
and
170 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| // 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 ). | ||
|
|
||
| //! Data provider always serving the same struct. | ||
| use core::fmt; | ||
| use icu_provider::any::MaybeSendSync; | ||
| use icu_provider::prelude::*; | ||
| use yoke::trait_hack::YokeTraitHack; | ||
| use yoke::Yokeable; | ||
|
|
||
| /// A data provider that returns clones of a fixed type-erased payload. | ||
| /// | ||
| /// [`FixedProvider`] implements [`AnyProvider`], so it can be used in | ||
| /// `*_with_any_provider` constructors across ICU4X. | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use icu_provider::hello_world::*; | ||
| /// use icu_provider::prelude::*; | ||
| /// use icu_provider_adapters::fixed::FixedProvider; | ||
| /// use std::borrow::Cow; | ||
| /// use writeable::assert_writeable_eq; | ||
| /// | ||
| /// let provider = | ||
| /// FixedProvider::<HelloWorldV1Marker>::from_static(&HelloWorldV1 { | ||
| /// message: Cow::Borrowed("custom hello world"), | ||
| /// }); | ||
| /// | ||
| /// // Check that it works: | ||
| /// let formatter = HelloWorldFormatter::try_new_with_any_provider( | ||
| /// &provider, | ||
| /// &Default::default(), | ||
| /// ) | ||
| /// .expect("marker matches"); | ||
| /// assert_writeable_eq!(formatter.format(), "custom hello world"); | ||
| /// | ||
| /// # struct DummyMarker; | ||
| /// # impl DynamicDataMarker for DummyMarker { | ||
| /// # type DataStruct = <HelloWorldV1Marker as DynamicDataMarker>::DataStruct; | ||
| /// # } | ||
| /// # impl DataMarker for DummyMarker { | ||
| /// # const INFO: DataMarkerInfo = DataMarkerInfo::from_path(icu_provider::marker::data_marker_path!("dummy@1")); | ||
| /// # } | ||
| /// // Requests for invalid markers get MissingDataMarker | ||
| /// assert!(matches!( | ||
| /// provider.load_any(DummyMarker::INFO, Default::default()), | ||
| /// Err(DataError { | ||
| /// kind: DataErrorKind::MarkerNotFound, | ||
| /// .. | ||
| /// }) | ||
| /// )) | ||
| /// ``` | ||
| #[allow(clippy::exhaustive_structs)] // this type is stable | ||
| pub struct FixedProvider<M: DataMarker> { | ||
| data: DataPayload<M>, | ||
| } | ||
|
|
||
| impl<M: DataMarker> FixedProvider<M> { | ||
| /// Creates a `FixedProvider` with an owned (allocated) payload of the given data. | ||
| pub fn from_owned(data: M::DataStruct) -> Self { | ||
| Self::from_payload(DataPayload::from_owned(data)) | ||
| } | ||
|
|
||
| /// Creates a `FixedProvider` with a statically borrowed payload of the given data. | ||
| pub fn from_static(data: &'static M::DataStruct) -> Self { | ||
| FixedProvider { | ||
| data: DataPayload::from_static_ref(data), | ||
| } | ||
| } | ||
|
|
||
| /// Creates a `FixedProvider` from an existing [`DataPayload`]. | ||
| pub fn from_payload(data: DataPayload<M>) -> Self { | ||
| FixedProvider { data } | ||
| } | ||
|
|
||
| /// Creates a `FixedProvider` with the default (allocated) version of the data struct. | ||
| pub fn new_default() -> Self | ||
| where | ||
| M::DataStruct: Default, | ||
| { | ||
| Self::from_owned(M::DataStruct::default()) | ||
| } | ||
| } | ||
|
|
||
| impl<M: DataMarker> AnyProvider for FixedProvider<M> | ||
| where | ||
| for<'a> YokeTraitHack<<M::DataStruct as Yokeable<'a>>::Output>: Clone, | ||
| M::DataStruct: MaybeSendSync, | ||
| { | ||
| fn load_any(&self, marker: DataMarkerInfo, _: DataRequest) -> Result<AnyResponse, DataError> { | ||
| marker.match_marker(M::INFO)?; | ||
| Ok(AnyResponse { | ||
| metadata: DataResponseMetadata::default(), | ||
| payload: self.data.clone().wrap_into_any_payload(), | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| impl<M> DataProvider<M> for FixedProvider<M> | ||
| where | ||
| M: DataMarker, | ||
| for<'a> YokeTraitHack<<M::DataStruct as Yokeable<'a>>::Output>: Clone, | ||
| { | ||
| fn load(&self, _: DataRequest) -> Result<DataResponse<M>, DataError> { | ||
| Ok(DataResponse { | ||
| metadata: Default::default(), | ||
| payload: self.data.clone(), | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| impl<M> fmt::Debug for FixedProvider<M> | ||
| where | ||
| M: DynamicDataMarker, | ||
| M: DataMarker, | ||
| for<'a> &'a <M::DataStruct as Yokeable<'a>>::Output: fmt::Debug, | ||
| { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| self.data.fmt(f) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.