Deserialise returns Result<...> now.

Author: boocmp

benches/bench_serialization.rs

@@ -1,6 +1,6 @@
 use criterion::*;
 
-use adblock::{Engine, EngineSerializer};
+use adblock::Engine;
 
 #[path = "../tests/test_utils.rs"]
 mod test_utils;

examples/deserialization.rs

@@ -1,4 +1,4 @@
-use adblock::{request::Request, Engine, EngineSerializer};
+use adblock::{request::Request, Engine};
 
 use serde::Deserialize;
 

examples/generate-dat.rs

@@ -1,4 +1,4 @@
-use adblock::{request::Request, Engine, EngineSerializer};
+use adblock::{request::Request, Engine};
 
 use std::fs::File;
 use std::io::prelude::*;

examples/use-dat.rs

@@ -1,4 +1,4 @@
-use adblock::{request::Request, Engine, EngineSerializer};
+use adblock::{request::Request, Engine};
 
 use std::fs::File;
 use std::io::prelude::*;

src/data_format/mod.rs

@@ -67,6 +67,13 @@ pub enum DeserializationError {
     /// crate. If you still need it for some reason, you can convert it using 0.7.x by
     /// deserializing and then reserializing it into the newer V0 format.
     LegacyFormatNoLongerSupported,
+    InvalidFlatBuffer(flatbuffers::InvalidFlatbuffer),
+}
+
+impl From<std::convert::Infallible> for DeserializationError {
+    fn from(x: std::convert::Infallible) -> Self {
+        match x {}
+    }
 }
 
 impl From<rmp_serde::decode::Error> for DeserializationError {
@@ -75,10 +82,16 @@ impl From<rmp_serde::decode::Error> for DeserializationError {
     }
 }
 
+impl From<flatbuffers::InvalidFlatbuffer> for DeserializationError {
+    fn from(e: flatbuffers::InvalidFlatbuffer) -> Self {
+        Self::InvalidFlatBuffer(e)
+    }
+}
+
 impl DeserializeFormat {
-    pub(crate) fn build(self) -> (Blocker, CosmeticFilterCache) {
+    pub(crate) fn build(self) -> Result<(Blocker, CosmeticFilterCache), DeserializationError> {
         match self {
-            Self::V0(v) => v.into(),
+            Self::V0(v) => v.try_into(),
         }
     }
 

src/data_format/v0.rs

@@ -379,16 +379,17 @@ pub(crate) struct NetworkFilterListV0DeserializeFmt {
     pub unique_domains_hashes_map: HashMap<crate::utils::Hash, u16>,
 }
 
-impl From<NetworkFilterListV0DeserializeFmt> for NetworkFilterList {
-    fn from(v: NetworkFilterListV0DeserializeFmt) -> Self {
-        let _ = fb::root_as_network_filter_list(&v.flatbuffer_memory)
-            .expect("Flatbuffer is not corrupted");
-        Self {
+impl TryFrom<NetworkFilterListV0DeserializeFmt> for NetworkFilterList {
+    fn try_from(v: NetworkFilterListV0DeserializeFmt) -> Result<Self, Self::Error> {
+        let _ = fb::root_as_network_filter_list(&v.flatbuffer_memory)?;
+        Ok(Self {
             flatbuffer_memory: v.flatbuffer_memory,
             filter_map: v.filter_map,
             unique_domains_hashes_map: v.unique_domains_hashes_map,
-        }
+        })
     }
+
+    type Error = DeserializationError;
 }
 
 /// Structural representation of adblock engine data that can be built up from deserialization and
@@ -471,25 +472,25 @@ impl<'a> From<(&'a Blocker, &'a CosmeticFilterCache)> for SerializeFormat<'a> {
     }
 }
 
-impl From<DeserializeFormat> for (Blocker, CosmeticFilterCache) {
-    fn from(v: DeserializeFormat) -> Self {
+impl TryFrom<DeserializeFormat> for (Blocker, CosmeticFilterCache) {
+    fn try_from(v: DeserializeFormat) -> Result<Self, Self::Error> {
         use crate::cosmetic_filter_cache::HostnameFilterBin;
 
         let mut specific_rules: HostnameRuleDb = v.specific_rules.into();
         specific_rules.procedural_action = HostnameFilterBin(v.procedural_action);
         specific_rules.procedural_action_exception =
             HostnameFilterBin(v.procedural_action_exception);
 
-        (
+        Ok((
             Blocker {
-                csp: v.csp.into(),
-                exceptions: v.exceptions.into(),
-                importants: v.importants.into(),
-                redirects: v.redirects.into(),
+                csp: v.csp.try_into()?,
+                exceptions: v.exceptions.try_into()?,
+                importants: v.importants.try_into()?,
+                redirects: v.redirects.try_into()?,
                 removeparam: NetworkFilterList::default(),
-                filters_tagged: v.filters_tagged.into(),
-                filters: v.filters.into(),
-                generic_hide: v.generic_hide.into(),
+                filters_tagged: v.filters_tagged.try_into()?,
+                filters: v.filters.try_into()?,
+                generic_hide: v.generic_hide.try_into()?,
 
                 tags_enabled: Default::default(),
                 tagged_filters_all: v.tagged_filters_all.into_iter().map(|f| f.into()).collect(),
@@ -507,6 +508,8 @@ impl From<DeserializeFormat> for (Blocker, CosmeticFilterCache) {
 
                 misc_generic_selectors: v.misc_generic_selectors,
             },
-        )
+        ))
     }
+
+    type Error = DeserializationError;
 }

src/engine.rs

@@ -264,7 +264,7 @@ impl Engine {
         use crate::data_format::DeserializeFormat;
         let current_tags = self.blocker.tags_enabled();
         let deserialize_format = DeserializeFormat::deserialize(serialized)?;
-        let (blocker, cosmetic_cache) = deserialize_format.build();
+        let (blocker, cosmetic_cache) = deserialize_format.build()?;
         self.blocker = blocker;
         self.blocker
             .use_tags(&current_tags.iter().map(|s| &**s).collect::<Vec<_>>());