Struct TransactionIndex

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

A transaction’s index in its block.

Consensus

A 2-byte index supports on-disk storage of transactions in blocks up to ~5 MB. (The current maximum block size is 2 MB.)

Since Zebra only stores fully verified blocks on disk, blocks larger than this size are rejected before reaching the database.

(The maximum transaction count is tested by the large generated block serialization tests.)

Implementations

impl TransactionIndex

pub const MIN: Self

The minimum value of a transaction index.

This value corresponds to the coinbase transaction.

pub const MAX: Self

The maximum value of a transaction index.

This value corresponds to the highest possible transaction index.

pub fn from_index(transaction_index: u16) -> TransactionIndex

Creates a transaction index from the inner type.

pub fn index(&self) -> u16

Returns this index as the inner type.

pub fn from_usize(transaction_index: usize) -> TransactionIndex

Creates a transaction index from a usize.

pub fn as_usize(&self) -> usize

Returns this index as a usize.

pub fn from_u64(transaction_index: u64) -> TransactionIndex

Creates a transaction index from a u64.

pub fn as_u64(&self) -> u64

Returns this index as a u64.

Trait Implementations

impl Clone for TransactionIndex

fn clone(&self) -> TransactionIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionIndex

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

Formats the value using the given formatter.

impl FromDisk for TransactionIndex

fn from_bytes(disk_bytes: impl AsRef<[u8]>) -> Self

Converts raw disk bytes back into the deserialized type.

impl Hash for TransactionIndex

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 IntoDisk for TransactionIndex

TransactionIndex is only serialized as part of TransactionLocation

type Bytes = [u8; 2]

The type used to write bytes to disk, and compare a value as a key to on-disk keys.

fn as_bytes(&self) -> Self::Bytes

Converts the current type into serialized raw bytes.

impl Ord for TransactionIndex

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

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

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

impl Eq for TransactionIndex

impl StructuralPartialEq for TransactionIndex