Struct zebra_state::service::finalized_state::disk_format::transparent::AddressUnspentOutput

pub struct AddressUnspentOutput {
    address_location: OutputLocation,
    unspent_output_location: OutputLocation,
}

A single unspent output for a transparent::Address.

We store both the address location key and unspend output location value in the RocksDB column family key. This improves insert and delete performance.

This requires 8 extra bytes for each unspent output, because we repeat the key for each value. But RocksDB compression reduces the duplicate data size on disk.

Fields

address_location: OutputLocation

The location of the first transparent::Output sent to the address in output.

unspent_output_location: OutputLocation

The location of this unspent output.

Implementations

impl AddressUnspentOutput

pub fn new( address_location: OutputLocation, unspent_output_location: OutputLocation, ) -> AddressUnspentOutput

Create a new AddressUnspentOutput from an address location, and an unspent output location.

pub fn address_iterator_start( address_location: OutputLocation, ) -> AddressUnspentOutput

Create an AddressUnspentOutput which starts iteration for the supplied address. Used to look up the first output with ReadDisk::zs_next_key_value_from.

The unspent output location is before all unspent output locations in the index. It is always invalid, due to the genesis consensus rules. But this is not an issue since ReadDisk::zs_next_key_value_from will fetch the next existing (valid) value.

pub fn address_iterator_next(&mut self)

Update the unspent output location to the next possible output for the supplied address. Used to look up the next output with ReadDisk::zs_next_key_value_from.

The updated unspent output location may be invalid, which is not an issue since ReadDisk::zs_next_key_value_from will fetch the next existing (valid) value.

pub fn address_location(&self) -> OutputLocation

The location of the first transparent::Output sent to the address of this output.

This can be used to look up the address.

pub fn unspent_output_location(&self) -> OutputLocation

The location of this unspent output.

pub fn address_location_mut(&mut self) -> &mut OutputLocation

Allows tests to modify the address location.

pub fn unspent_output_location_mut(&mut self) -> &mut OutputLocation

Allows tests to modify the unspent output location.

Trait Implementations

impl Arbitrary for AddressUnspentOutput

type Parameters = (<OutputLocation as Arbitrary>::Parameters, <OutputLocation as Arbitrary>::Parameters)

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

type Strategy = Map<(<OutputLocation as Arbitrary>::Strategy, <OutputLocation as Arbitrary>::Strategy), fn(_: (OutputLocation, OutputLocation)) -> AddressUnspentOutput>

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 AddressUnspentOutput

fn clone(&self) -> AddressUnspentOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddressUnspentOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddressUnspentOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromDisk for AddressUnspentOutput

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

Converts raw disk bytes back into the deserialized type.

impl IntoDisk for AddressUnspentOutput

type Bytes = [u8; 16]

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 AddressUnspentOutput

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

Restrict a value to a certain interval.

impl PartialEq for AddressUnspentOutput

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AddressUnspentOutput

impl Eq for AddressUnspentOutput

impl StructuralPartialEq for AddressUnspentOutput