Enum PruneMode

pub enum PruneMode {
    Full,
    Distance(u64),
    Before(BlockNumber),
}

Prune mode.

Variants

Full

Prune all blocks.

Distance(u64)

Prune blocks before the head-N block number. In other words, keep last N + 1 blocks.

Before(BlockNumber)

Prune blocks before the specified block number. The specified block number is not pruned.

Implementations

impl PruneMode

pub const fn bitflag_encoded_bytes() -> usize

Used bytes by [PruneModeFlags]

pub const fn bitflag_unused_bits() -> usize

Unused bits for new fields by [PruneModeFlags]

impl PruneMode

pub const fn before_inclusive(block_number: BlockNumber) -> Self

Prune blocks up to the specified block number. The specified block number is also pruned.

This acts as PruneMode::Before(block_number + 1).

pub fn prune_target_block( &self, tip: BlockNumber, segment: PruneSegment, purpose: PrunePurpose, ) -> Result<Option<(BlockNumber, Self)>, PruneSegmentError>

Returns block up to which variant pruning needs to be done, inclusive, according to the provided tip.

pub const fn should_prune(&self, block: BlockNumber, tip: BlockNumber) -> bool

Check if target block should be pruned according to the provided prune mode and tip.

pub const fn is_full(&self) -> bool

Returns true if the prune mode is PruneMode::Full.

pub const fn is_distance(&self) -> bool

Returns true if the prune mode is PruneMode::Distance.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for PruneMode

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

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.

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.

impl Clone for PruneMode

fn clone(&self) -> PruneMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compact for PruneMode

fn to_compact<B>(&self, buf: &mut B) -> usize

where B: BufMut + AsMut<[u8]>,

Takes a buffer which can be written to. Ideally, it returns the length written to.

fn from_compact(buf: &[u8], len: usize) -> (Self, &[u8])

Takes a buffer which can be read from. Returns the object and buf with its internal cursor advanced (eg..advance(len)).

fn specialized_to_compact<B>(&self, buf: &mut B) -> usize

where B: BufMut + AsMut<[u8]>,

“Optional”: If there’s no good reason to use it, don’t.

fn specialized_from_compact(buf: &[u8], len: usize) -> (Self, &[u8])

“Optional”: If there’s no good reason to use it, don’t.

impl Debug for PruneMode

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

Formats the value using the given formatter.

impl Default for PruneMode

Available on crate feature test-utils only.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PruneMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PruneMode

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

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 PruneMode

impl Eq for PruneMode

impl StructuralPartialEq for PruneMode

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

Size for each variant:

• Full: 0 bytes
• Distance: 8 bytes
• Before: 8 bytes