Struct MinimumPeerVersion

pub struct MinimumPeerVersion<C> {
    network: Network,
    chain_tip: C,
    current_minimum: Version,
    has_changed: bool,
}

A helper type to monitor the chain tip in order to determine the minimum peer protocol version that is currently supported.

Fields

network: Network

chain_tip: C

current_minimum: Version

has_changed: bool

Implementations

impl MinimumPeerVersion<MockChainTip>

pub fn with_mock_chain_tip(network: &Network) -> (Self, MockChainTipSender)

impl<C> MinimumPeerVersion<C>

where C: ChainTip,

pub fn new(chain_tip: C, network: &Network) -> Self

Create a new MinimumPeerVersion to track the minimum supported peer protocol version for the current chain_tip on the network.

pub fn changed(&mut self) -> Option<Version>

Check if the minimum supported peer version has changed since the last time this was called.

The first call returns the current minimum version, and subsequent calls return None until the minimum version changes. When that happens, the next call returns the new minimum version, and subsequent calls return None again until the minimum version changes once more.

pub fn current(&mut self) -> Version

Retrieve the current minimum supported peer protocol version.

fn update(&mut self)

Check the current chain tip height to determine the minimum peer version, and detect if it has changed.

pub fn chain_tip_height(&self) -> Height

Return the current chain tip height.

If it is not available return height zero.

Trait Implementations

impl<C> Clone for MinimumPeerVersion<C>

where C: Clone,

A custom Clone implementation to ensure that the first call to MinimumPeerVersion::changed after the clone will always return the current version.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for MinimumPeerVersion<C>

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

Formats the value using the given formatter.