1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
// 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 ).
//! Providers that filter resource requests.
//!
//! Requests that fail a filter test will return [`DataError`] of kind [`FilteredResource`](
//! DataErrorKind::FilteredResource) and will not appear in [`IterableProvider`] iterators.
//!
//! The main struct is [`RequestFilterDataProvider`]. Although that struct can be created
//! directly, the traits in this module provide helper functions for common filtering patterns.
//!
//! To create a `RequestFilterDataProvider`, you can use the [`Filterable`] blanket function:
//!
//! ```
//! use icu_provider::filter::Filterable;
//!
//! // now call .filterable() on any object to get a RequestFilterDataProvider
//! ```
//!
//! # Examples
//!
//! ```
//! use icu_provider::prelude::*;
//! use icu_provider::hello_world::*;
//! use icu_provider::filter::Filterable;
//! use icu_locid_macros::language;
//!
//! // Only return German data from a HelloWorldProvider:
//! HelloWorldProvider::new_with_placeholder_data()
//! .filterable("Demo German-only filter")
//! .filter_by_langid(|langid| langid.language == language!("de"));
//! ```
//!
//! [`IterableProvider`]: crate::iter::IterableProvider
mod impls;
pub use impls::*;
use crate::iter::IterableProvider;
use crate::prelude::*;
use alloc::boxed::Box;
/// A data provider that selectively filters out data requests.
///
/// Data requests that are rejected by the filter will return a [`DataError`] with kind
/// [`FilteredResource`](DataErrorKind::FilteredResource), and they will not be returned
/// by [`IterableProvider::supported_options_for_key`].
///
/// Although this struct can be created directly, the traits in this module provide helper
/// functions for common filtering patterns.
pub struct RequestFilterDataProvider<D, F>
where
F: Fn(&DataRequest) -> bool,
{
/// The data provider to which we delegate requests.
pub inner: D,
/// The predicate function. A return value of `true` indicates that the request should
/// proceed as normal; a return value of `false` will reject the request.
pub predicate: F,
/// A name for this filter, used in error messages.
pub filter_name: &'static str,
}
impl<D, F, M> DataProvider<M> for RequestFilterDataProvider<D, F>
where
F: Fn(&DataRequest) -> bool,
M: DataMarker,
D: DataProvider<M>,
{
fn load_payload(&self, req: &DataRequest) -> Result<DataResponse<M>, DataError> {
if (self.predicate)(req) {
self.inner.load_payload(req)
} else {
Err(DataErrorKind::FilteredResource
.with_str_context(self.filter_name)
.with_req(req))
}
}
}
impl<D, F> BufferProvider for RequestFilterDataProvider<D, F>
where
F: Fn(&DataRequest) -> bool,
D: BufferProvider,
{
fn load_buffer(&self, req: &DataRequest) -> Result<DataResponse<BufferMarker>, DataError> {
if (self.predicate)(req) {
self.inner.load_buffer(req)
} else {
Err(DataErrorKind::FilteredResource
.with_str_context(self.filter_name)
.with_req(req))
}
}
}
impl<D, F> IterableProvider for RequestFilterDataProvider<D, F>
where
F: Fn(&DataRequest) -> bool,
D: IterableProvider,
{
fn supported_options_for_key(
&self,
resc_key: &ResourceKey,
) -> Result<Box<dyn Iterator<Item = ResourceOptions> + '_>, DataError> {
self.inner.supported_options_for_key(resc_key).map(|iter| {
let resc_key = *resc_key;
// Use filter_map instead of filter to avoid cloning the options
let filtered_iter = iter.filter_map(move |options| {
let request = DataRequest {
resource_path: ResourcePath {
key: resc_key,
options,
},
};
if (self.predicate)(&request) {
Some(request.resource_path.options)
} else {
None
}
});
let boxed_filtered_iter: Box<dyn Iterator<Item = ResourceOptions>> =
Box::new(filtered_iter);
boxed_filtered_iter
})
}
}
pub trait Filterable: Sized {
/// Creates a filterable data provider with the given name for debugging.
///
/// For more details, see [`icu_provider::filter`](crate::filter).
fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<Self, fn(&DataRequest) -> bool>;
}
impl<T> Filterable for T
where
T: Sized,
{
fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<Self, fn(&DataRequest) -> bool> {
fn noop(_: &DataRequest) -> bool {
true
}
RequestFilterDataProvider {
inner: self,
predicate: noop,
filter_name,
}
}
}