Struct libp2p::gossipsub::subscription_filter::WhitelistSubscriptionFilter

pub struct WhitelistSubscriptionFilter(pub HashSet<TopicHash, RandomState>);

Allows only whitelisted subscriptions

Trait Implementations

impl Clone for WhitelistSubscriptionFilter

pub 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

pub fn default() -> WhitelistSubscriptionFilter

Returns the “default value” for a type.

impl TopicSubscriptionFilter for WhitelistSubscriptionFilter

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

pub fn filter_incoming_subscription_set(
    &mut self,
    subscriptions: HashSet<&'a GossipsubSubscription, RandomState>,
    _currently_subscribed_topics: &BTreeSet<TopicHash>
) -> Result<HashSet<&'a GossipsubSubscription, RandomState>, 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.