feat!: optionally filter locales

Author: aleb2000

examples/all_files.rs

@@ -13,7 +13,7 @@ fn main() {
     for path in Iter::new(default_paths()) {
         let path_src = PathSource::guess_from(&path);
         if let Ok(bytes) = fs::read_to_string(&path) {
-            if let Ok(entry) = DesktopEntry::from_str(&path, &bytes, &locales) {
+            if let Ok(entry) = DesktopEntry::from_str(&path, &bytes, Some(&locales)) {
                 println!("{:?}: {}\n---\n{}", path_src, path.display(), entry);
             }
         }

examples/bench.rs

@@ -26,7 +26,7 @@ fn bench_borrowed(it: u32) {
 
         for path in paths {
             if let Ok(bytes) = fs::read_to_string(&path) {
-                if let Ok(_entry) = DesktopEntry::from_str(&path, &bytes, &locale) {}
+                if let Ok(_entry) = DesktopEntry::from_str(&path, &bytes, Some(&locale)) {}
             }
         }
 
@@ -46,7 +46,7 @@ fn bench_owned(it: u32) {
         let now = Instant::now();
 
         for path in paths {
-            if let Ok(_entry) = DesktopEntry::from_path(path, &locale) {}
+            if let Ok(_entry) = DesktopEntry::from_path(path, Some(&locale)) {}
         }
 
         total_time += now.elapsed();
@@ -64,7 +64,7 @@ fn bench_owned_optimized(it: u32) {
 
         let now = Instant::now();
 
-        let _ = DesktopEntry::from_paths(paths, &locale)
+        let _ = DesktopEntry::from_paths(paths, Some(&locale))
             .filter_map(|e| e.ok())
             .collect::<Vec<_>>();
 

examples/specific_file.rs

@@ -12,7 +12,7 @@ fn main() {
     //     }
     // }
 
-    if let Ok(entry) = DesktopEntry::from_path(path.to_path_buf(), locales) {
+    if let Ok(entry) = DesktopEntry::from_path(path.to_path_buf(), Some(locales)) {
         println!("{}\n---\n{}", path.display(), entry);
     }
 }

src/decoder.rs

@@ -25,7 +25,7 @@ impl<'a> DesktopEntry<'a> {
     pub fn from_str<L>(
         path: &'a Path,
         input: &'a str,
-        locales: &[L],
+        locales_filter: Option<&[L]>,
     ) -> Result<DesktopEntry<'a>, DecodeError>
     where
         L: AsRef<str>,
@@ -36,15 +36,15 @@ impl<'a> DesktopEntry<'a> {
         let mut active_group = Cow::Borrowed("");
         let mut ubuntu_gettext_domain = None;
 
-        let locales = add_generic_locales(locales);
+        let locales_filter = locales_filter.map(add_generic_locales);
 
         for line in input.lines() {
             process_line(
                 line,
                 &mut groups,
                 &mut active_group,
                 &mut ubuntu_gettext_domain,
-                &locales,
+                locales_filter.as_deref(),
                 Cow::Borrowed,
             )
         }
@@ -59,25 +59,25 @@ impl<'a> DesktopEntry<'a> {
 
     pub fn from_paths<'i, 'l: 'i, L>(
         paths: impl Iterator<Item = PathBuf> + 'i,
-        locales: &'l [L],
+        locales_filter: Option<&'l [L]>,
     ) -> impl Iterator<Item = Result<DesktopEntry<'static>, DecodeError>> + 'i
     where
         L: AsRef<str>,
     {
         let mut buf = String::new();
-        let locales = add_generic_locales(locales);
+        let locales_filter = locales_filter.map(add_generic_locales);
 
-        paths.map(move |path| decode_from_path_with_buf(path, &locales, &mut buf))
+        paths.map(move |path| decode_from_path_with_buf(path, locales_filter.as_deref(), &mut buf))
     }
 
     /// Return an owned [`DesktopEntry`]
-    pub fn from_path<L>(path: PathBuf, locales: &[L]) -> Result<DesktopEntry<'static>, DecodeError>
+    pub fn from_path<L>(path: PathBuf, locales_filter: Option<&[L]>) -> Result<DesktopEntry<'static>, DecodeError>
     where
         L: AsRef<str>,
     {
         let mut buf = String::new();
-        let locales = add_generic_locales(locales);
-        decode_from_path_with_buf(path, &locales, &mut buf)
+        let locales_filter = locales_filter.map(add_generic_locales);
+        decode_from_path_with_buf(path, locales_filter.as_deref(), &mut buf)
     }
 }
 
@@ -97,7 +97,7 @@ fn process_line<'buf, 'local_ref, 'res: 'local_ref + 'buf, F, L>(
     groups: &'local_ref mut Groups<'res>,
     active_group: &'local_ref mut Cow<'res, str>,
     ubuntu_gettext_domain: &'local_ref mut Option<Cow<'res, str>>,
-    locales_filter: &[L],
+    locales_filter: Option<&[L]>,
     convert_to_cow: F,
 ) where
     F: Fn(&'buf str) -> Cow<'res, str>,
@@ -124,8 +124,9 @@ fn process_line<'buf, 'local_ref, 'res: 'local_ref + 'buf, F, L>(
                 let key_name = &key[..start];
                 let locale = &key[start + 1..key.len() - 1];
 
-                if !locales_filter.iter().any(|l| l.as_ref() == locale) {
-                    return;
+                match locales_filter {
+                    Some(locales_filter) if !locales_filter.iter().any(|l| l.as_ref() == locale) => return,
+                    _ => (),
                 }
 
                 groups
@@ -157,7 +158,7 @@ fn process_line<'buf, 'local_ref, 'res: 'local_ref + 'buf, F, L>(
 #[inline]
 fn decode_from_path_with_buf<L>(
     path: PathBuf,
-    locales: &[L],
+    locales_filter: Option<&[L]>,
     buf: &mut String,
 ) -> Result<DesktopEntry<'static>, DecodeError>
 where
@@ -179,7 +180,7 @@ where
             &mut groups,
             &mut active_group,
             &mut ubuntu_gettext_domain,
-            locales,
+            locales_filter,
             |s| Cow::Owned(s.to_owned()),
         );
         buf.clear();

src/lib.rs

@@ -476,7 +476,7 @@ fn add_field() {
 fn env_with_locale() {
     let locales = &["fr_FR"];
 
-    let de = DesktopEntry::from_path(PathBuf::from("tests/org.mozilla.firefox.desktop"), locales)
+    let de = DesktopEntry::from_path(PathBuf::from("tests/org.mozilla.firefox.desktop"), Some(locales))
         .unwrap();
 
     assert_eq!(de.generic_name(locales).unwrap(), "Navigateur Web");

src/matching.rs

@@ -242,7 +242,7 @@ mod test {
     #[test]
     fn find_de() {
         let entries =
-            DesktopEntry::from_paths(Iter::new(default_paths()), &get_languages_from_env())
+            DesktopEntry::from_paths(Iter::new(default_paths()), Some(&get_languages_from_env()))
                 .filter_map(|e| e.ok())
                 .collect::<Vec<_>>();