Struct libp2p::gossipsub::subscription_filter::regex::RegexSubscriptionFilter
source · pub struct RegexSubscriptionFilter(pub Regex);
Expand description
A subscription filter that filters topics based on a regular expression.
Tuple Fields§
§0: Regex
Trait Implementations§
source§impl TopicSubscriptionFilter for RegexSubscriptionFilter
impl TopicSubscriptionFilter for RegexSubscriptionFilter
source§fn can_subscribe(&mut self, topic_hash: &TopicHash) -> bool
fn can_subscribe(&mut self, topic_hash: &TopicHash) -> bool
Returns true iff the topic is of interest and we can subscribe to it.
source§fn filter_incoming_subscriptions<'a>(
&mut self,
subscriptions: &'a [GossipsubSubscription],
currently_subscribed_topics: &BTreeSet<TopicHash, Global>
) -> Result<HashSet<&'a GossipsubSubscription, RandomState>, String>
fn filter_incoming_subscriptions<'a>(
&mut self,
subscriptions: &'a [GossipsubSubscription],
currently_subscribed_topics: &BTreeSet<TopicHash, Global>
) -> Result<HashSet<&'a GossipsubSubscription, RandomState>, String>
Filters a list of incoming subscriptions and returns a filtered set
By default this deduplicates the subscriptions and calls
Self::filter_incoming_subscription_set
on the filtered set. Read moresource§fn filter_incoming_subscription_set<'a>(
&mut self,
subscriptions: HashSet<&'a GossipsubSubscription, RandomState>,
_currently_subscribed_topics: &BTreeSet<TopicHash, Global>
) -> Result<HashSet<&'a GossipsubSubscription, RandomState>, String>
fn filter_incoming_subscription_set<'a>(
&mut self,
subscriptions: HashSet<&'a GossipsubSubscription, RandomState>,
_currently_subscribed_topics: &BTreeSet<TopicHash, Global>
) -> Result<HashSet<&'a GossipsubSubscription, RandomState>, String>
Filters a set of deduplicated subscriptions
By default this filters the elements based on
Self::allow_incoming_subscription
. Read moresource§fn allow_incoming_subscription(
&mut self,
subscription: &GossipsubSubscription
) -> bool
fn allow_incoming_subscription(
&mut self,
subscription: &GossipsubSubscription
) -> bool
Returns true iff we allow an incoming subscription.
This is used by the default implementation of filter_incoming_subscription_set to decide
whether to filter out a subscription or not.
By default this uses can_subscribe to decide the same for incoming subscriptions as for
outgoing ones. Read more