Struct JoinOptions

pub struct JoinOptions {
    pub bootstrap: BTreeSet<NodeId>,
    pub subscription_capacity: usize,
}

Available on crate feature net only.

Options for joining a gossip topic.

Fields

bootstrap: BTreeSet<NodeId>

The initial bootstrap nodes.

subscription_capacity: usize

The maximum number of messages that can be buffered in a subscription.

If this limit is reached, the subscriber will receive a Lagged response, the message will be dropped, and the subscriber will be closed.

This is to prevent a single slow subscriber from blocking the dispatch loop. If a subscriber is lagging, it should be closed and re-opened.

Implementations

impl JoinOptions

pub fn with_bootstrap(nodes: impl IntoIterator<Item = NodeId>) -> Self

Creates JoinOptions with the provided bootstrap nodes and the default subscription capacity.

Trait Implementations

impl Debug for JoinOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JoinOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JoinOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.