Type Alias ExtentKey

pub type ExtentKey = ExtentKeyV32;

ExtentKey is a child of ObjectKey for Object attributes that have attached extents (at time of writing this was only the used for file contents).

Aliased Type

struct ExtentKey {
    pub range: Range<u64>,
}

Fields

range: Range<u64>

Implementations

impl ExtentKey

pub fn new(range: Range<u64>) -> Self

Creates an ExtentKey.

pub fn overlap(&self, other: &ExtentKey) -> Option<Range<u64>>

Returns the range of bytes common between this extent and |other|.

pub fn search_key(&self) -> Self

Returns the search key for this extent; that is, a key which is <= this key under Ord and OrdLowerBound. This would be used when searching for an extent with |find| (when we want to find any overlapping extent, which could include extents that start earlier). For example, if the tree has extents 50..150 and 150..200 and we wish to read 100..200, we’d search for 0..101 which would set the iterator to 50..150.

pub fn search_key_from_offset(offset: u64) -> Self

Similar to previous, but from an offset. Returns a search key that will find the first extent that touches offset..

pub fn key_for_merge_into(&self) -> Self

Returns the merge key for this extent; that is, a key which is <= this extent and any other possibly overlapping extent, under Ord. This would be used to set the hint for |merge_into|.

For example, if the tree has extents 0..50, 50..150 and 150..200 and we wish to insert 100..150, we’d use a merge hint of 0..100 which would set the iterator to 50..150 (the first element > 100..150 under Ord).

pub fn fuzzy_hash_partition(&self) -> ExtentKeyPartitionIterator

Returns an iterator over the ExtentKey partitions which overlap this key (see FuzzyHash).

Trait Implementations

impl Ord for ExtentKey

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 OrdLowerBound for ExtentKey

fn cmp_lower_bound(&self, other: &ExtentKey) -> Ordering

impl OrdUpperBound for ExtentKey

fn cmp_upper_bound(&self, other: &ExtentKey) -> Ordering

impl PartialOrd for ExtentKey

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.