Struct grin_core::ser::ProtocolVersion

pub struct ProtocolVersion(pub u32);

Protocol version for serialization/deserialization. Note: This is used in various places including but limited to the p2p layer and our local db storage layer. We may speak multiple versions to various peers and a potentially different version for our local db.

Methods

impl ProtocolVersion

pub const MAX: u32

The max protocol version supported.

pub fn value(self) -> u32

Protocol version as u32 to allow for convenient exhaustive matching on values.

pub fn local() -> ProtocolVersion

Our default "local" protocol version. This protocol version is provided to peers as part of the Hand/Shake negotiation in the p2p layer. Connected peers will negotiate a suitable protocol version for serialization/deserialization of p2p messages.

pub fn local_db() -> ProtocolVersion

We need to specify a protocol version for our local database. Regardless of specific version used when sending/receiving data between peers we need to take care with serialization/deserialization of data locally in the db.

Trait Implementations

impl Clone for ProtocolVersion

fn clone(&self) -> ProtocolVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ProtocolVersion

impl Debug for ProtocolVersion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolVersion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for ProtocolVersion

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

Formats the value using the given formatter.

impl Eq for ProtocolVersion

impl From<ProtocolVersion> for u32

fn from(v: ProtocolVersion) -> u32

Performs the conversion.

impl Ord for ProtocolVersion

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ProtocolVersion> for ProtocolVersion

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

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

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

This method tests for !=.

impl PartialOrd<ProtocolVersion> for ProtocolVersion

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

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

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

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

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

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

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

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

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

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

impl Readable for ProtocolVersion

fn read(reader: &mut dyn Reader) -> Result<ProtocolVersion, Error>

Reads the data necessary to this Readable from the provided reader

impl Serialize for ProtocolVersion

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

Serialize this value into the given Serde serializer.

impl StructuralEq for ProtocolVersion

impl StructuralPartialEq for ProtocolVersion

impl Writeable for ProtocolVersion

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer