Struct polkadot_node_network_protocol::View

pub struct View {
    pub finalized_number: BlockNumber,
    /* private fields */
}

A succinct representation of a peer’s view. This consists of a bounded amount of chain heads and the highest known finalized block number.

Up to N (5?) chain heads.

Fields

finalized_number: BlockNumber

The highest known finalized block number.

Implementations

impl View

pub fn new( heads: impl IntoIterator<Item = Hash>, finalized_number: BlockNumber, ) -> Self

Construct a new view based on heads and a finalized block number.

pub fn with_finalized(finalized_number: BlockNumber) -> Self

Start with no heads, but only a finalized block number.

pub fn len(&self) -> usize

Obtain the number of heads that are in view.

pub fn is_empty(&self) -> bool

Check if the number of heads contained, is null.

pub fn iter(&self) -> impl Iterator<Item = &Hash>

Obtain an iterator over all heads.

pub fn into_iter(self) -> impl Iterator<Item = Hash>

Obtain an iterator over all heads.

pub fn replace_difference(&mut self, new: View) -> impl Iterator<Item = &Hash>

Replace self with new.

Returns an iterator that will yield all elements of new that were not part of self.

pub fn difference<'a>( &'a self, other: &'a View, ) -> impl Iterator<Item = &'a Hash> + 'a

Returns an iterator of the hashes present in Self but not in other.

pub fn intersection<'a>( &'a self, other: &'a View, ) -> impl Iterator<Item = &'a Hash> + 'a

An iterator containing hashes present in both Self and in other.

pub fn contains(&self, hash: &Hash) -> bool

Whether the view contains a given hash.

pub fn check_heads_eq(&self, other: &Self) -> bool

Check if two views have the same heads.

Equivalent to the PartialEq function, but ignores the finalized_number field.

Trait Implementations

impl Clone for View

fn clone(&self) -> View

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for View

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

Formats the value using the given formatter.

impl Decode for View

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for View

fn default() -> View

Returns the “default value” for a type.

impl Encode for View

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl PartialEq for View

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl EncodeLike for View

impl Eq for View

impl StructuralPartialEq for View