Struct MultiApiVersion

pub struct MultiApiVersion(Vec<ApiVersion>);

Multiple, disjoint, minimum required or maximum supported, ApiVersions.

If a given component can (potentially) support multiple different (distinct major number), of an API, this type is used to express it.

All ApiVersion values are in the context of the current consensus version for the component in question.

Each element must have a distinct major api number, and means either minimum required API version of this major number (for the client), or maximum supported version of this major number (for the server).

Tuple Fields

0: Vec<ApiVersion>

Implementations

impl MultiApiVersion

pub fn new() -> Self

fn is_consistent(&self) -> bool

Verify the invariant: sorted by unique major numbers

fn iter(&self) -> MultiApiVersionIter<'_>

pub fn try_from_iter<T: IntoIterator<Item = ApiVersion>>( iter: T, ) -> Result<Self, ApiVersion>

fn try_insert(&mut self, version: ApiVersion) -> Result<(), &mut u32>

Insert version to the list of supported APIs

Returns Ok if no existing element with the same major version was found and new version was successfully inserted. Returns Err if an existing element with the same major version was found, to allow modifying its minor number. This is useful when merging required / supported version sequences with each other.

pub(crate) fn get_by_major(&self, major: u32) -> Option<ApiVersion>

Trait Implementations

impl Clone for MultiApiVersion

fn clone(&self) -> MultiApiVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiApiVersion

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

Formats the value using the given formatter.

impl Decodable for MultiApiVersion

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl Default for MultiApiVersion

fn default() -> MultiApiVersion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MultiApiVersion

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for MultiApiVersion

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, H::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl<'a> IntoIterator for &'a MultiApiVersion

type Item = ApiVersion

The type of the elements being iterated over.

type IntoIter = MultiApiVersionIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for MultiApiVersion

fn eq(&self, other: &MultiApiVersion) -> 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 Serialize for MultiApiVersion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MultiApiVersion

impl StructuralPartialEq for MultiApiVersion