Struct SequenceNumber

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

Implementations

impl SequenceNumber

pub fn one_before(&self) -> Option<SequenceNumber>

pub fn next(&self) -> SequenceNumber

impl SequenceNumber

pub const MIN_VALID_INCL: SequenceNumber

An inclusive lower limit on a valid sequence number.

A valid sequence number means an object, which this sequence number is assigned to, does not appear in a cancelled transaction.

pub const MAX_VALID_EXCL: SequenceNumber

An exclusive upper limit on a valid sequence number: sequence numbers strictly smaller than this limit are valid sequence numbers.

A valid sequence number means an object, which this sequence number is assigned to, does not appear in a cancelled transaction. Sequence numbers larger than this value are “special” and assigned to objects that appear in cancelled transactions.

pub const CANCELLED_READ: SequenceNumber

Special sequence number that is assigned to objects which are accessed immutably in a cancelled transaction.

pub const CONGESTED_PRIOR_TO_GAS_PRICE_FEEDBACK: SequenceNumber

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

pub const RANDOMNESS_UNAVAILABLE: SequenceNumber

Special sequence number that is assigned the randomness state object if randomness is unavailable.

pub const fn new() -> Self

pub const fn value(&self) -> u64

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

pub fn new_congested_with_suggested_gas_price(suggested_gas_price: u64) -> Self

Returns a special sequence number used for congested shared objects: SequenceNumber::MIN_CONGESTED.value() + suggested_gas_price, where suggested_gas_price is embedded into a congested sequence number to facilitate a gas price feedback mechanism for transactions cancelled due to shared object congestion.

pub fn is_congested(&self) -> bool

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

pub fn get_congested_version_suggested_gas_price(&self) -> u64

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

pub fn increment(&mut self)

pub fn increment_to(&mut self, next: SequenceNumber)

pub fn decrement(&mut self)

pub fn decrement_to(&mut self, prev: SequenceNumber)

pub fn lamport_increment( inputs: impl IntoIterator<Item = SequenceNumber>, ) -> SequenceNumber

Returns a new sequence number that is greater than all SequenceNumbers in inputs, assuming this operation will not overflow.

pub fn is_cancelled(&self) -> bool

Checks if this sequence number is cancelled, i.e., the corresponding object appears in a cancelled transaction.

pub fn is_valid(&self) -> bool

Checks if this sequence number is valid, i.e., the corresponding object does not appear in a cancelled transaction.

Trait Implementations

impl Arbitrary for SequenceNumber

type Parameters = <u64 as Arbitrary>::Parameters

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

type Strategy = Map<<u64 as Arbitrary>::Strategy, fn(_: u64) -> SequenceNumber>

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

fn arbitrary_with(_top: Self::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 SequenceNumber

fn clone(&self) -> SequenceNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SequenceNumber

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

Formats the value using the given formatter.

impl Default for SequenceNumber

fn default() -> SequenceNumber

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SequenceNumber

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeAs<'de, SequenceNumber> for SequenceNumber

fn deserialize_as<D>(deserializer: D) -> Result<SequenceNumber, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SequenceNumber

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

Formats the value using the given formatter.

impl From<SequenceNumber> for u64

fn from(val: SequenceNumber) -> Self

Converts to this type from the input type.

impl From<SequenceNumber> for usize

fn from(value: SequenceNumber) -> Self

Converts to this type from the input type.

impl From<u64> for SequenceNumber

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for SequenceNumber

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 JsonSchema for SequenceNumber

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for SequenceNumber

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

impl PartialEq for SequenceNumber

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SerializeAs<SequenceNumber> for SequenceNumber

fn serialize_as<S>( value: &SequenceNumber, serializer: S, ) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SequenceNumber

impl Eq for SequenceNumber

impl StructuralPartialEq for SequenceNumber