Re-export subscription filters from root

Author: thomaseizinger

protocols/gossipsub/src/lib.rs

@@ -158,10 +158,14 @@ pub mod protocol {
 
 mod subscription_filter_priv;
 #[deprecated(
-    note = "The `subscription_filter` module will be made private in the future and should not be depended on."
+    note = "The `subscription_filter` module will be made private in the future, import the types from the crate root instead."
 )]
 pub mod subscription_filter {
     pub use super::subscription_filter_priv::*;
+
+    pub mod regex {
+        pub use crate::subscription_filter_priv::RegexSubscriptionFilter;
+    }
 }
 
 mod time_cache_priv;
@@ -194,6 +198,11 @@ pub use self::peer_score::{
     score_parameter_decay, score_parameter_decay_with_base, PeerScoreParams, PeerScoreThresholds,
     TopicScoreParams,
 };
+pub use self::subscription_filter_priv::{
+    AllowAllSubscriptionFilter, CallbackSubscriptionFilter, CombinedSubscriptionFilters,
+    MaxCountSubscriptionFilter, RegexSubscriptionFilter, TopicSubscriptionFilter,
+    WhitelistSubscriptionFilter,
+};
 pub use self::topic::{Hasher, Topic, TopicHash};
 pub use self::transform::{DataTransform, IdentityTransform};
 pub use self::types::{FastMessageId, Message, MessageAcceptance, MessageId, RawMessage, Rpc};

protocols/gossipsub/src/subscription_filter_priv.rs

@@ -200,55 +200,12 @@ where
     }
 }
 
-pub mod regex {
-    use super::TopicSubscriptionFilter;
-    use crate::TopicHash;
-    use regex::Regex;
+///A subscription filter that filters topics based on a regular expression.
+pub struct RegexSubscriptionFilter(pub regex::Regex);
 
-    ///A subscription filter that filters topics based on a regular expression.
-    pub struct RegexSubscriptionFilter(pub Regex);
-
-    impl TopicSubscriptionFilter for RegexSubscriptionFilter {
-        fn can_subscribe(&mut self, topic_hash: &TopicHash) -> bool {
-            self.0.is_match(topic_hash.as_str())
-        }
-    }
-
-    #[cfg(test)]
-    mod test {
-        use super::*;
-        use crate::types::Subscription;
-        use crate::types::SubscriptionAction::*;
-
-        #[test]
-        fn test_regex_subscription_filter() {
-            let t1 = TopicHash::from_raw("tt");
-            let t2 = TopicHash::from_raw("et3t3te");
-            let t3 = TopicHash::from_raw("abcdefghijklmnopqrsuvwxyz");
-
-            let mut filter = RegexSubscriptionFilter(Regex::new("t.*t").unwrap());
-
-            let old = Default::default();
-            let subscriptions = vec![
-                Subscription {
-                    action: Subscribe,
-                    topic_hash: t1,
-                },
-                Subscription {
-                    action: Subscribe,
-                    topic_hash: t2,
-                },
-                Subscription {
-                    action: Subscribe,
-                    topic_hash: t3,
-                },
-            ];
-
-            let result = filter
-                .filter_incoming_subscriptions(&subscriptions, &old)
-                .unwrap();
-            assert_eq!(result, subscriptions[..2].iter().collect());
-        }
+impl TopicSubscriptionFilter for RegexSubscriptionFilter {
+    fn can_subscribe(&mut self, topic_hash: &TopicHash) -> bool {
+        self.0.is_match(topic_hash.as_str())
     }
 }
 
@@ -447,4 +404,34 @@ mod test {
             .unwrap();
         assert_eq!(result, vec![&subscriptions[0]].into_iter().collect());
     }
+
+    #[test]
+    fn test_regex_subscription_filter() {
+        let t1 = TopicHash::from_raw("tt");
+        let t2 = TopicHash::from_raw("et3t3te");
+        let t3 = TopicHash::from_raw("abcdefghijklmnopqrsuvwxyz");
+
+        let mut filter = RegexSubscriptionFilter(Regex::new("t.*t").unwrap());
+
+        let old = Default::default();
+        let subscriptions = vec![
+            Subscription {
+                action: Subscribe,
+                topic_hash: t1,
+            },
+            Subscription {
+                action: Subscribe,
+                topic_hash: t2,
+            },
+            Subscription {
+                action: Subscribe,
+                topic_hash: t3,
+            },
+        ];
+
+        let result = filter
+            .filter_incoming_subscriptions(&subscriptions, &old)
+            .unwrap();
+        assert_eq!(result, subscriptions[..2].iter().collect());
+    }
 }