Struct PeerSample 

pub struct PeerSample { /* private fields */ }

A list of peers to be exchanged between two nodes.

peaveil builds a PeerSample by drawing a uniformly random subset of its View and ships it to a randomly-chosen peer. The recipient merges the received entries into its own view, deduplicating by SocketAddr.

Implementations

impl PeerSample

pub const MAX_ENTRIES: usize

Maximum number of entries a single sample can carry. The wire format uses a 1-byte count field, so a PeerSample can hold at most 255 entries. In practice the configured sample_size (default 8) is well under this; encoding more than 255 entries is a programmer error.

pub fn empty() -> Self

Returns an empty sample. Useful for “ping” exchanges that test liveness without contributing new peers.

pub fn from_entries(entries: Vec<PeerEntry>) -> Self

Builds a sample from a list of entries. The entries are not validated; the caller is expected to de-duplicate and bound the size before calling.

pub fn entries(&self) -> &[PeerEntry]

Returns the entries of this sample.

pub fn len(&self) -> usize

Returns the number of entries.

pub fn is_empty(&self) -> bool

Returns true if the sample has no entries.

pub fn encoded_size(&self) -> usize

Returns the encoded size of this sample, in bytes, when serialized as a peaveil payload.

pub fn encode(&self) -> BytesMut

Encodes this sample into a freshly-allocated BytesMut. The returned buffer is exactly self.encoded_size() bytes long.

Panics

Panics if self.len() > Self::MAX_ENTRIES.

pub fn decode(buf: &[u8]) -> Result<Self, DecodeError>

Decodes a peaveil payload. Returns Err(_) if the buffer is too short, has a wrong magic, has a wrong version, or has a truncated trailing entry. Trailing bytes after the last declared entry are ignored, since the on-the-wire format pads the sample with random bytes to fit the peashape frame size.

Trait Implementations

impl Clone for PeerSample

fn clone(&self) -> PeerSample

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PeerSample

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

Formats the value using the given formatter.

impl Default for PeerSample

fn default() -> PeerSample

Returns the “default value” for a type.

impl Eq for PeerSample

impl PartialEq for PeerSample

fn eq(&self, other: &PeerSample) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PeerSample