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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
// 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 ).
use super::*;
use alloc::boxed::Box;
use icu_provider::prelude::*;
use icu_locid::LanguageIdentifier;
type RequestFilterDataProviderOutput<'a, D> =
RequestFilterDataProvider<D, Box<dyn Fn(DataRequest) -> bool + Sync + 'a>>;
impl<D, F> RequestFilterDataProvider<D, F>
where
F: Fn(DataRequest) -> bool + Sync,
{
/// Filter out data requests with certain langids according to the predicate function. The
/// predicate should return `true` to allow a langid and `false` to reject a langid.
///
/// Data requests with no langid will be allowed. To reject data requests without a langid,
/// chain this with [`Self::require_langid`].
///
/// # Examples
///
/// ```
/// use icu_locid::LanguageIdentifier;
/// use icu_locid::{langid, subtags::language};
/// use icu_provider::datagen::*;
/// use icu_provider::hello_world::*;
/// use icu_provider::prelude::*;
/// use icu_provider_adapters::filter::Filterable;
///
/// let provider = HelloWorldProvider
/// .filterable("Demo no-English filter")
/// .filter_by_langid(|langid| langid.language != language!("en"));
///
/// // German requests should succeed:
/// let req_de = DataRequest {
/// locale: &langid!("de").into(),
/// metadata: Default::default(),
/// };
/// let response: Result<DataResponse<HelloWorldV1Marker>, _> =
/// provider.load(req_de);
/// assert!(matches!(response, Ok(_)));
///
/// // English requests should fail:
/// let req_en = DataRequest {
/// locale: &langid!("en-US").into(),
/// metadata: Default::default(),
/// };
/// let response: Result<DataResponse<HelloWorldV1Marker>, _> =
/// provider.load(req_en);
/// assert!(matches!(
/// response,
/// Err(DataError {
/// kind: DataErrorKind::FilteredResource,
/// ..
/// })
/// ));
///
/// // English should not appear in the iterator result:
/// let supported_langids = provider
/// .supported_locales()
/// .expect("Should successfully make an iterator of supported locales")
/// .into_iter()
/// .map(|options| options.get_langid())
/// .collect::<Vec<LanguageIdentifier>>();
/// assert!(supported_langids.contains(&langid!("de")));
/// assert!(!supported_langids.contains(&langid!("en")));
/// ```
pub fn filter_by_langid<'a>(
self,
predicate: impl Fn(&LanguageIdentifier) -> bool + Sync + 'a,
) -> RequestFilterDataProviderOutput<'a, D>
where
F: 'a,
{
let old_predicate = self.predicate;
RequestFilterDataProvider {
inner: self.inner,
predicate: Box::new(move |request| -> bool {
if !(old_predicate)(request) {
return false;
}
predicate(&request.locale.get_langid())
}),
filter_name: self.filter_name,
}
}
/// Filter out data request except those having a language identifier that exactly matches
/// one in the allowlist.
///
/// This will be replaced with a smarter algorithm for locale filtering; see
/// <https://github.com/unicode-org/icu4x/issues/834>
///
/// Data requests with no langid will be allowed. To reject data requests without a langid,
/// chain this with [`Self::require_langid`].
///
/// # Examples
///
/// ```
/// use icu_locid::langid;
/// use icu_provider::hello_world::*;
/// use icu_provider::prelude::*;
/// use icu_provider_adapters::filter::Filterable;
///
/// let allowlist = [langid!("de"), langid!("zh")];
/// let provider = HelloWorldProvider
/// .filterable("Demo German+Chinese filter")
/// .filter_by_langid_allowlist_strict(&allowlist);
///
/// // German requests should succeed:
/// let req_de = DataRequest {
/// locale: &langid!("de").into(),
/// metadata: Default::default(),
/// };
/// let response: Result<DataResponse<HelloWorldV1Marker>, _> =
/// provider.load(req_de);
/// assert!(matches!(response, Ok(_)));
///
/// // English requests should fail:
/// let req_en = DataRequest {
/// locale: &langid!("en-US").into(),
/// metadata: Default::default(),
/// };
/// let response: Result<DataResponse<HelloWorldV1Marker>, _> =
/// provider.load(req_en);
/// assert!(matches!(
/// response,
/// Err(DataError {
/// kind: DataErrorKind::FilteredResource,
/// ..
/// })
/// ));
/// assert_eq!(
/// response.unwrap_err().str_context,
/// Some("Demo German+Chinese filter")
/// );
/// ```
pub fn filter_by_langid_allowlist_strict<'a>(
self,
allowlist: &'a [LanguageIdentifier],
) -> RequestFilterDataProviderOutput<'a, D>
where
F: 'a,
{
let old_predicate = self.predicate;
RequestFilterDataProvider {
inner: self.inner,
predicate: Box::new(move |request| -> bool {
if !(old_predicate)(request) {
return false;
}
request.locale.is_langid_und() || allowlist.contains(&request.locale.get_langid())
}),
filter_name: self.filter_name,
}
}
/// Require that data requests contain a langid.
///
/// # Examples
///
/// ```
/// use icu_locid::langid;
/// use icu_provider::hello_world::*;
/// use icu_provider::prelude::*;
/// use icu_provider_adapters::filter::Filterable;
///
/// let provider = HelloWorldProvider
/// .filterable("Demo require-langid filter")
/// .require_langid();
///
/// // Requests with a langid should succeed:
/// let req_with_langid = DataRequest {
/// locale: &langid!("de").into(),
/// metadata: Default::default(),
/// };
/// let response: Result<DataResponse<HelloWorldV1Marker>, _> =
/// provider.load(req_with_langid);
/// assert!(matches!(response, Ok(_)));
///
/// // Requests without a langid should fail:
/// let req_no_langid = DataRequest {
/// locale: Default::default(),
/// metadata: Default::default(),
/// };
/// let response: Result<DataResponse<HelloWorldV1Marker>, _> =
/// provider.load(req_no_langid);
/// assert!(matches!(
/// response,
/// Err(DataError {
/// kind: DataErrorKind::FilteredResource,
/// ..
/// })
/// ));
/// ```
pub fn require_langid<'a>(self) -> RequestFilterDataProviderOutput<'a, D>
where
F: 'a,
{
let old_predicate = self.predicate;
RequestFilterDataProvider {
inner: self.inner,
predicate: Box::new(move |request| -> bool {
if !(old_predicate)(request) {
return false;
}
!request.locale.is_langid_und()
}),
filter_name: self.filter_name,
}
}
}