Removed EngineSerializer trait.

Author: boocmp

js/src/lib.rs

@@ -4,7 +4,6 @@ use adblock::lists::{
 use adblock::resources::resource_assembler::assemble_web_accessible_resources;
 use adblock::resources::Resource;
 use adblock::Engine as EngineInternal;
-use adblock::EngineSerializer as EngineSerializerInternal;
 use neon::prelude::*;
 use neon::types::buffer::TypedArray as _;
 use serde::{Deserialize, Serialize};

src/engine.rs

@@ -244,6 +244,33 @@ impl Engine {
     pub fn get_regex_debug_info(&self) -> crate::regex_manager::RegexDebugInfo {
         self.blocker.get_regex_debug_info()
     }
+
+    /// Serializes the `Engine` into a binary format so that it can be quickly reloaded later.
+    pub fn serialize(&self) -> Result<Vec<u8>, crate::data_format::SerializationError> {
+        use crate::data_format::SerializeFormat;
+
+        let serialize_format = SerializeFormat::build(&self.blocker, &self.cosmetic_cache);
+
+        let result = serialize_format.serialize()?;
+        Ok(result)
+    }
+
+    /// Deserialize the `Engine` from the binary format generated by `Engine::serialize`. The
+    /// method will automatically select the correct deserialization implementation.
+    pub fn deserialize(
+        &mut self,
+        serialized: &[u8],
+    ) -> Result<(), crate::data_format::DeserializationError> {
+        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();
+        self.blocker = blocker;
+        self.blocker
+            .use_tags(&current_tags.iter().map(|s| &**s).collect::<Vec<_>>());
+        self.cosmetic_cache = cosmetic_cache;
+        Ok(())
+    }
 }
 
 /// Static assertions for `Engine: Send + Sync` traits.

src/engine_serializer.rs

@@ -17,7 +17,7 @@ use crate::utils::Hash;
 pub mod flat;
 use flat::fb;
 
-pub struct FlatNetworkFiltersListBuilder<'a> {
+pub(crate) struct FlatNetworkFiltersListBuilder<'a> {
     builder: flatbuffers::FlatBufferBuilder<'a>,
     filters: Vec<WIPOffset<fb::NetworkFilter<'a>>>,
 
@@ -133,7 +133,7 @@ impl<'a> FlatNetworkFiltersListBuilder<'a> {
         binary
     }
 }
-pub struct FlatPatterns<'a> {
+pub(crate) struct FlatPatterns<'a> {
     patterns: Option<flatbuffers::Vector<'a, flatbuffers::ForwardsUOffset<&'a str>>>,
 }
 
@@ -155,7 +155,7 @@ impl<'a> FlatPatterns<'a> {
     }
 }
 
-pub struct FlatPatternsIterator<'a> {
+pub(crate) struct FlatPatternsIterator<'a> {
     patterns: &'a FlatPatterns<'a>,
     len: usize,
     index: usize,
@@ -184,7 +184,7 @@ impl<'a> ExactSizeIterator for FlatPatternsIterator<'a> {
     }
 }
 
-pub struct FlatNetworkFilter<'a> {
+pub(crate) struct FlatNetworkFilter<'a> {
     key: u64,
     owner: &'a NetworkFilterList,
     fb_filter: &'a fb::NetworkFilter<'a>,

src/filters/fb_network.rs

@@ -22,7 +22,6 @@ pub mod content_blocking;
 pub mod cosmetic_filter_cache;
 mod data_format;
 mod engine;
-mod engine_serializer;
 pub mod filters;
 pub mod lists;
 mod network_filter_list;
@@ -37,7 +36,6 @@ pub mod utils;
 
 #[doc(inline)]
 pub use engine::Engine;
-pub use engine_serializer::EngineSerializer;
 #[doc(inline)]
 pub use lists::FilterSet;
 

src/lib.rs

@@ -316,7 +316,7 @@ mod legacy_test_filters {
 
 mod legacy_check_match {
     use adblock::request::Request;
-    use adblock::{Engine, EngineSerializer};
+    use adblock::Engine;
 
     fn check_match<'a>(
         rules: &[&'a str],
@@ -855,7 +855,6 @@ mod legacy_misc_tests {
     use adblock::filters::network::NetworkFilter;
     use adblock::request::Request;
     use adblock::Engine;
-    use adblock::EngineSerializer;
 
     #[test]
     fn demo_app() {

tests/legacy_harness.rs

@@ -1,5 +1,5 @@
 use adblock::request::Request;
-use adblock::{Engine, EngineSerializer};
+use adblock::Engine;
 
 use serde::Deserialize;
 use tokio::runtime::Runtime;

tests/live.rs

@@ -171,7 +171,6 @@ fn check_specifics_default() {
 
 #[test]
 fn check_basic_works_after_deserialization() {
-    use adblock::EngineSerializer;
     let engine = get_blocker_engine();
     let serialized = engine.serialize().unwrap();
     let mut deserialized_engine = Engine::default();

tests/ublock-coverage.rs

@@ -1,7 +1,6 @@
 #[cfg(test)]
 mod tests {
     use super::super::*;
-    use crate::engine_serializer::EngineSerializer;
     use crate::lists::FilterFormat;
     use crate::resources::MimeType;
     use base64::{engine::Engine as _, prelude::BASE64_STANDARD};