Struct libp2p_gossipsub::subscription_filter::WhitelistSubscriptionFilter

pub struct WhitelistSubscriptionFilter(pub HashSet<TopicHash>);

[−] Expand description

Allows only whitelisted subscriptions

Trait Implementations

impl Clone for WhitelistSubscriptionFilter

[+] Show hidden undocumented items

fn clone(&self) -> WhitelistSubscriptionFilter[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Default for WhitelistSubscriptionFilter

[+] Show hidden undocumented items

fn default() -> WhitelistSubscriptionFilter[−]

Returns the “default value” for a type.

impl TopicSubscriptionFilter for WhitelistSubscriptionFilter

[+] Show hidden undocumented items

fn can_subscribe(&mut self, topic_hash: &TopicHash) -> bool[−]

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

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.

fn filter_incoming_subscription_set<'a>(
    &mut self,
    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.

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.