Skip to main content

BlockAccessIndex

Struct BlockAccessIndex 

Source
#[repr(transparent)]
pub struct BlockAccessIndex(pub u64);
Expand description

Block access index within a block.

A block’s indices are laid out as:

  • 0 — pre-execution (system contract calls, block-level setup, …)
  • 1..=tx_len — transaction execution (transaction index i maps to index i + 1)
  • tx_len + 1 — post-execution (block rewards, withdrawals, …)

Stored as a u64 internally, but wrapped as a newtype so it cannot be accidentally confused with other u64 indices (for example, an account_id passed alongside it).

RLP, borsh, and arbitrary representations are identical to the wrapped u64. Serde serializes as a hex "quantity" string (e.g. "0x1a"), matching the previous BlockAccessIndex = u64 alias behavior when paired with the crate::quantity module.

Tuple Fields§

§0: u64

Implementations§

Source§

impl BlockAccessIndex

Source

pub const PRE_EXECUTION: BlockAccessIndex

Pre-execution slot (index 0).

Source

pub const fn new(value: u64) -> BlockAccessIndex

Constructs a new BlockAccessIndex from a raw u64.

Source

pub const fn from_tx_index(tx_index: u64) -> BlockAccessIndex

Constructs a new BlockAccessIndex from a 0-based transaction index.

Transaction changes start at index 1 in a block access list, so transaction index 0 maps to block access index 1.

Source

pub const fn get(self) -> u64

Returns the raw u64 value.

Source

pub const fn increment(&mut self)

Bumps the index by 1.

Source

pub const fn phase(self, tx_len: usize) -> Option<BlockAccessPhase>

Classifies this index into a BlockAccessPhase, given the number of transactions in the block.

Returns:

  • Some(BlockAccessPhase::PreExecution) when the index is 0.
  • Some(BlockAccessPhase::Transaction(i)) when the index is in 1..=tx_len, with i = index - 1 as a 0-based transaction index.
  • Some(BlockAccessPhase::PostExecution) when the index is exactly tx_len + 1.
  • None when the index is strictly greater than tx_len + 1 (out of range for a block with tx_len transactions).

Trait Implementations§

Source§

impl<'arbitrary> Arbitrary<'arbitrary> for BlockAccessIndex

Source§

fn arbitrary( u: &mut Unstructured<'arbitrary>, ) -> Result<BlockAccessIndex, Error>

Generate an arbitrary value of Self from the given unstructured data. Read more
Source§

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<BlockAccessIndex, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
Source§

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
Source§

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
Source§

impl Clone for BlockAccessIndex

Source§

fn clone(&self) -> BlockAccessIndex

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BlockAccessIndex

Source§

impl Debug for BlockAccessIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Decodable for BlockAccessIndex

Source§

fn decode(buf: &mut &[u8]) -> Result<BlockAccessIndex, Error>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.
Source§

impl Default for BlockAccessIndex

Source§

fn default() -> BlockAccessIndex

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BlockAccessIndex

Available on crate feature serde only.
Source§

fn deserialize<D>( deserializer: D, ) -> Result<BlockAccessIndex, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for BlockAccessIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Encodable for BlockAccessIndex

Source§

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes. Read more
Source§

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.
Source§

impl Eq for BlockAccessIndex

Source§

impl Hash for BlockAccessIndex

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LowerHex for BlockAccessIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Ord for BlockAccessIndex

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for BlockAccessIndex

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for BlockAccessIndex

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for BlockAccessIndex

Available on crate feature serde only.
Source§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BlockAccessIndex

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes