Enum PruningSeed

pub enum PruningSeed {
    NotPruned,
    Pruned(DecompressedPruningSeed),
}

A valid pruning seed for a Monero node.

A pruning seed tells nodes which blocks they should keep and which they should prune.

Variants

NotPruned

A peer with this seed is not pruned.

Pruned(DecompressedPruningSeed)

A peer with this seed is pruned.

Implementations

impl PruningSeed

pub fn new_pruned(stripe: u32, log_stripes: u32) -> Result<Self, PruningError>

Creates a new PruningSeed::Pruned seed.

See: DecompressedPruningSeed::new

pub fn decompress(seed: u32) -> Result<Self, PruningError>

Attempts to decompress a raw pruning seed.

An error means the pruning seed was invalid.

pub fn decompress_p2p_rules(seed: u32) -> Result<Self, PruningError>

Decompresses the seed, performing the same checks as PruningSeed::decompress and some more according to Monero’s p2p networks rules.

The only added check currently is that log_stripes == 3.

pub const fn compress(&self) -> u32

Compresses this pruning seed to a u32.

pub const fn get_log_stripes(&self) -> Option<u32>

Returns the log_stripes for this seed, if this seed is pruned otherwise None is returned.

pub const fn get_stripe(&self) -> Option<u32>

Returns the stripe for this seed, if this seed is pruned otherwise None is returned.

pub const fn has_full_block( &self, height: usize, blockchain_height: usize, ) -> bool

Returns true if a peer with this pruning seed should have a non-pruned version of a block.

pub fn get_next_pruned_block( &self, block_height: usize, blockchain_height: usize, ) -> Result<Option<usize>, PruningError>

Gets the next pruned block for a given block_height and blockchain_height

Each seed will store, in a cyclic manner, a portion of blocks while discarding the ones that are out of your stripe. This function is finding the next height for which a specific seed will start pruning blocks.

This will return Ok(None) if the seed does no pruning or if there is no pruned block after this one.

Errors

This function will return an Error if the inputted block_height or blockchain_height is greater than MAX_BLOCK_HEIGHT_USIZE.

This function will also error if block_height > blockchain_height

pub fn get_next_unpruned_block( &self, block_height: usize, blockchain_height: usize, ) -> Result<usize, PruningError>

Gets the next unpruned block for a given block_height and blockchain_height

Each seed will store, in a cyclic manner, a portion of blocks while discarding the ones that are out of your stripe. This function is finding the next height for which a specific seed will start storing blocks.

Errors

This function will return an Error if the inputted block_height or blockchain_height is greater than MAX_BLOCK_HEIGHT_USIZE.

This function will also error if block_height > blockchain_height

Trait Implementations

impl BorshDeserialize for PruningSeed

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

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

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for PruningSeed

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for PruningSeed

fn clone(&self) -> PruningSeed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PruningSeed

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

Formats the value using the given formatter.

impl EnumExt for PruningSeed

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8, ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl Hash for PruningSeed

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 Ord for PruningSeed

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

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

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

impl Eq for PruningSeed

impl StructuralPartialEq for PruningSeed

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: 12 bytes

Size for each variant:

• NotPruned: 0 bytes
• Pruned: 8 bytes