Struct Version 

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

Implementations

impl Version

pub const MIN_VALID_INCL: Self

An inclusive lower limit on a valid version.

A valid version means an object, which this version is assigned to, does not appear in a canceled transaction.

pub const INITIAL_SHARED_VERSION: Self

The initial shared version for shared system objects.

pub const MAX_VALID_EXCL: Self

An exclusive upper limit on a valid version: versions strictly smaller than this limit are valid versions.

A valid version means an object, which this version is assigned to, does not appear in a canceled transaction. Versions larger than this value are “special” and assigned to objects that appear in canceled transactions.

pub const CANCELED_READ: Self

Special version that is assigned to objects which are accessed immutably in a canceled transaction.

pub const CONGESTED_PRIOR_TO_GAS_PRICE_FEEDBACK: Self

Special version that was assigned to congested objects which cause transaction cancellations. Note that this special version was only used prior to the introduction of a gas price feedback mechanism, but it is kept for backward compatibility.

pub const RANDOMNESS_UNAVAILABLE: Self

pub const OBJECT_START: Self

pub const fn from_u64(value: u64) -> Self

Create a new Version from a u64 value

pub const fn as_u64(&self) -> u64

Get the underlying u64 value of this version

pub fn next(self) -> Result<Self, VersionError>

Returns the next version, or an error if overflow occurs.

pub fn increment(&mut self) -> Result<(), VersionError>

Increments this version by one, or returns an error if overflow occurs.

pub fn previous(self) -> Result<Self, VersionError>

Returns the previous version, or an error if underflow occurs.

pub fn decrement(&mut self) -> Result<(), VersionError>

Decrements this version by one, or returns an error if underflow occurs.

pub fn new_congested_with_suggested_gas_price( suggested_gas_price: u64, ) -> Result<Self, VersionError>

Returns a special version used for congested shared objects: Version::MIN_CONGESTED + suggested_gas_price, where suggested_gas_price is embedded into a congested version to facilitate a gas price feedback mechanism for transactions canceled due to shared object congestion.

pub fn is_congested(&self) -> bool

Check if this version is congested, i.e., the corresponding object is the reason for transaction cancellation.

pub fn get_congested_version_suggested_gas_price( &self, ) -> Result<u64, VersionError>

Returns the suggested_gas_price embedded in this congested shared object version. The suggested_gas_price here is used for a gas price feedback mechanism for transactions canceled due to shared object congestion.

pub fn lamport_increment( inputs: impl IntoIterator<Item = Self>, ) -> Result<Self, VersionError>

Returns a new version that is greater than all versions in inputs, assuming this operation will not overflow.

pub fn is_canceled(&self) -> bool

Checks if this version is canceled, i.e., the corresponding object appears in a canceled transaction.

pub fn is_valid(&self) -> bool

Checks if this version is valid, i.e., the corresponding object does not appear in a canceled transaction.

Trait Implementations

impl Add for Version

type Output = Version

The resulting type after applying the + operator.

fn add(self, __rhs: Self) -> Self::Output

Performs the + operation.

impl Add<u64> for Version

type Output = Version

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl AddAssign for Version

fn add_assign(&mut self, __rhs: Self)

Performs the += operation.

impl AddAssign<u64> for Version

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl Arbitrary for Version

Available on crate feature proptest only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Version>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( args_shared: <Self as Arbitrary>::Parameters, ) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Version

fn clone(&self) -> Version

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Version

impl Debug for Version

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

Formats the value using the given formatter.

impl Default for Version

fn default() -> Version

Returns the “default value” for a type.

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

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Version

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

Formats the value using the given formatter.

impl<__derive_more_Rhs> Div<__derive_more_Rhs> for Version

where u64: Div<__derive_more_Rhs, Output = u64>,

type Output = Version

The resulting type after applying the / operator.

fn div(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the / operation.

impl<__derive_more_Rhs> DivAssign<__derive_more_Rhs> for Version

where u64: DivAssign<__derive_more_Rhs>,

fn div_assign(&mut self, __rhs: __derive_more_Rhs)

Performs the /= operation.

impl Eq for Version

impl From<u64> for Version

fn from(value: u64) -> Self

Converts to this type from the input type.

impl FromStr for Version

type Err = <u64 as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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<__derive_more_Rhs> Mul<__derive_more_Rhs> for Version

where u64: Mul<__derive_more_Rhs, Output = u64>,

type Output = Version

The resulting type after applying the * operator.

fn mul(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the * operation.

impl<__derive_more_Rhs> MulAssign<__derive_more_Rhs> for Version

where u64: MulAssign<__derive_more_Rhs>,

fn mul_assign(&mut self, __rhs: __derive_more_Rhs)

Performs the *= operation.

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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Version

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Version> for u64

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<u64> for Version

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

Equality operator ==.

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

Inequality operator !=.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<Version> for u64

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u64> for Version

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<__derive_more_Rhs> Rem<__derive_more_Rhs> for Version

where u64: Rem<__derive_more_Rhs, Output = u64>,

type Output = Version

The resulting type after applying the % operator.

fn rem(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the % operation.

impl<__derive_more_Rhs> RemAssign<__derive_more_Rhs> for Version

where u64: RemAssign<__derive_more_Rhs>,

fn rem_assign(&mut self, __rhs: __derive_more_Rhs)

Performs the %= operation.

impl Serialize for Version

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Version

impl Sub for Version

type Output = Version

The resulting type after applying the - operator.

fn sub(self, __rhs: Self) -> Self::Output

Performs the - operation.

impl Sub<u64> for Version

type Output = Version

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl SubAssign for Version

fn sub_assign(&mut self, __rhs: Self)

Performs the -= operation.

impl SubAssign<u64> for Version

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl Sum for Version

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<i64> for Version

type Error = <u64 as TryFrom<i64>>::Error

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.