Struct SaplingScannedDatabaseIndex

pub struct SaplingScannedDatabaseIndex {
    pub sapling_key: SaplingScanningKey,
    pub tx_loc: TransactionLocation,
}

A database column family key for a block scanned with a Sapling vieweing key.

Fields

sapling_key: SaplingScanningKey

The Sapling viewing key used to scan the block.

tx_loc: TransactionLocation

The transaction location: block height and transaction index.

Implementations

impl SaplingScannedDatabaseIndex

pub const fn min() -> Self

The minimum value of a sapling scanned database index.

This value is guarateed to be the minimum, and not correspond to a valid key.

pub fn min_for_key(sapling_key: &SaplingScanningKey) -> Self

The minimum value of a sapling scanned database index for sapling_key.

This value does not correspond to a valid entry. (The genesis coinbase transaction does not have shielded transfers.)

pub fn max_for_key(sapling_key: &SaplingScanningKey) -> Self

The maximum value of a sapling scanned database index for sapling_key.

This value may correspond to a valid entry, but it won’t be mined for many decades.

pub fn min_for_key_and_height( sapling_key: &SaplingScanningKey, height: Height, ) -> Self

The minimum value of a sapling scanned database index for sapling_key and height.

This value can be a valid entry for shielded coinbase.

pub fn max_for_key_and_height( sapling_key: &SaplingScanningKey, height: Height, ) -> Self

The maximum value of a sapling scanned database index for sapling_key and height.

This value can be a valid entry, but it won’t fit in a 2MB block.

Trait Implementations

impl Arbitrary for SaplingScannedDatabaseIndex

type Parameters = (<String as Arbitrary>::Parameters, <TransactionLocation as Arbitrary>::Parameters)

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

type Strategy = Map<(<String as Arbitrary>::Strategy, <TransactionLocation as Arbitrary>::Strategy), fn(_: (String, TransactionLocation)) -> SaplingScannedDatabaseIndex>

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 SaplingScannedDatabaseIndex

fn clone(&self) -> SaplingScannedDatabaseIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaplingScannedDatabaseIndex

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

Formats the value using the given formatter.

impl Default for SaplingScannedDatabaseIndex

fn default() -> SaplingScannedDatabaseIndex

Returns the “default value” for a type.

impl FromDisk for SaplingScannedDatabaseIndex

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

Converts raw disk bytes back into the deserialized type.

impl IntoDisk for SaplingScannedDatabaseIndex

type Bytes = Vec<u8>

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 SaplingScannedDatabaseIndex

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

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

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

impl StructuralPartialEq for SaplingScannedDatabaseIndex