Struct fedimint_core::module::version::ApiVersion

pub struct ApiVersion {
    pub major: u32,
    pub minor: u32,
}

Api version supported by a core server or a client/server module at a given ModuleConsensusVersion.

Changing ModuleConsensusVersion implies resetting the api versioning.

For a client and server to be able to communicate with each other:

• The client needs API version support for the ModuleConsensusVersion that the server is currently running with.
• Within that ModuleConsensusVersion during handshake negotiation process client and server must find at least one Api::major version where client’s minor is lower or equal server’s major version.

A practical module implementation needs to implement large range of version backward compatibility on both client and server side to accommodate end user client devices receiving updates at a pace hard to control, and technical and coordination challenges of upgrading servers.

Fields

major: u32

Major API version

Each time ModuleConsensusVersion is incremented, this number (and minor number as well) should be reset to 0.

Should be incremented each time the API was changed in a backward-incompatible ways (while resetting minor to 0).

minor: u32

Minor API version

• For clients this means minimum supported minor version of the major version required by client implementation
• For servers this means maximum supported minor version of the major version implemented by the server implementation

Implementations

impl ApiVersion

pub const fn new(major: u32, minor: u32) -> Self

Trait Implementations

impl Clone for ApiVersion

fn clone(&self) -> ApiVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiVersion

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

Formats the value using the given formatter.

impl Decodable for ApiVersion

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<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<'de> Deserialize<'de> for ApiVersion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for ApiVersion

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.

impl FromIterator<ApiVersion> for Result<MultiApiVersion, ApiVersion>

fn from_iter<T: IntoIterator<Item = ApiVersion>>(iter: T) -> Self

Creates a value from an iterator.

impl Ord for ApiVersion

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ApiVersion

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

use fedimint_core::module::ApiVersion;
assert!(ApiVersion { major: 3, minor: 3 } < ApiVersion { major: 4, minor: 0 });
assert!(ApiVersion { major: 3, minor: 3 } < ApiVersion { major: 3, minor: 5 });
assert!(ApiVersion { major: 3, minor: 3 } == ApiVersion { major: 3, minor: 3 });

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ApiVersion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ApiVersion

impl Eq for ApiVersion

impl StructuralPartialEq for ApiVersion