Struct bitcoin::block::Version

pub struct Version(/* private fields */);

Bitcoin block version number.

Originally used as a protocol version, but repurposed for soft-fork signaling.

The inner value is a signed integer in Bitcoin Core for historical reasons, if version bits is being used the top three bits must be 001, this gives us a useful range of [0x20000000…0x3FFFFFFF].

When a block nVersion does not have top bits 001, it is treated as if all bits are 0 for the purposes of deployments.

Relevant BIPs

• BIP9 - Version bits with timeout and delay (current usage)
• BIP34 - Block v2, Height in Coinbase

Implementations

impl Version

pub const ONE: Self = _

The original Bitcoin Block v1.

pub const TWO: Self = _

BIP-34 Block v2.

pub const NO_SOFT_FORK_SIGNALLING: Self = _

BIP-9 compatible version number that does not signal for any softforks.

pub const fn from_consensus(v: i32) -> Self

Creates a Version from a signed 32 bit integer value.

This is the data type used in consensus code in Bitcoin Core.

pub fn to_consensus(self) -> i32

Returns the inner i32 value.

This is the data type used in consensus code in Bitcoin Core.

pub fn is_signalling_soft_fork(&self, bit: u8) -> bool

Checks whether the version number is signalling a soft fork at the given bit.

A block is signalling for a soft fork under BIP-9 if the first 3 bits are 001 and the version bit for the specific soft fork is toggled on.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Version

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

Formats the value using the given formatter.

impl Decodable for Version

fn consensus_decode<R: BufRead + ?Sized>(r: &mut R) -> Result<Self, Error>

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R: BufRead + ?Sized>( reader: &mut R, ) -> Result<Self, Error>

Decode Self from a size-limited reader.

impl Default for Version

fn default() -> Version

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Version

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for Version

fn consensus_encode<W: Write + ?Sized>(&self, w: &mut W) -> Result<usize, Error>

Encodes an object with a well-defined format.

impl Hash for Version

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Version

fn cmp(&self, other: &Version) -> 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 Version

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

fn partial_cmp(&self, other: &Version) -> 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 Version

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 Version

impl Eq for Version

impl StructuralPartialEq for Version