Struct libp2p_gossipsub::subscription_filter::MaxCountSubscriptionFilter

pub struct MaxCountSubscriptionFilter<T: TopicSubscriptionFilter> {
    pub filter: T,
    pub max_subscribed_topics: usize,
    pub max_subscriptions_per_request: usize,
}

Adds a max count to a given subscription filter

Fields

filter: T

max_subscribed_topics: usize

max_subscriptions_per_request: usize

Trait Implementations

impl<T: TopicSubscriptionFilter> TopicSubscriptionFilter for MaxCountSubscriptionFilter<T>

pub fn can_subscribe(&mut self, topic_hash: &TopicHash) -> bool

Returns true iff the topic is of interest and we can subscribe to it.

pub fn filter_incoming_subscriptions<'a>(
    &mut self,
    subscriptions: &'a [GossipsubSubscription],
    currently_subscribed_topics: &BTreeSet<TopicHash>
) -> Result<HashSet<&'a GossipsubSubscription>, 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.

pub fn filter_incoming_subscription_set<'a>(
    &mut self,
    mut subscriptions: HashSet<&'a GossipsubSubscription>,
    _currently_subscribed_topics: &BTreeSet<TopicHash>
) -> Result<HashSet<&'a GossipsubSubscription>, String>

Filters a set of deduplicated subscriptions By default this filters the elements based on Self::allow_incoming_subscription.

pub 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.