Struct SearchKey 

pub struct SearchKey {
    pub tree_id: u64,
    pub min_objectid: u64,
    pub max_objectid: u64,
    pub min_type: u32,
    pub max_type: u32,
    pub min_offset: u64,
    pub max_offset: u64,
    pub min_transid: u64,
    pub max_transid: u64,
}

Parameters specifying which items to return from a tree search.

The kernel searches a 136-bit key space ordered as (objectid << 72) | (type << 64) | offset. All items whose key falls in the inclusive range [min_key, max_key] are returned.

Build a key for common cases with SearchKey::for_type or SearchKey::for_objectid_range.

Tree IDs and item type codes are the BTRFS_*_OBJECTID and BTRFS_*_KEY constants from crate::raw, cast to u64 and u32 respectively at the call site.

Fields

tree_id: u64

Tree to search — use a BTRFS_*_TREE_OBJECTID constant from crate::raw.

min_objectid: u64

max_objectid: u64

min_type: u32

Item type — use a BTRFS_*_KEY constant from crate::raw.

max_type: u32

min_offset: u64

max_offset: u64

min_transid: u64

Filter on the transaction ID of the metadata block that holds the item, not the transaction that created the item itself.

max_transid: u64

Implementations

impl SearchKey

pub fn for_type(tree_id: u64, item_type: u32) -> Self

Return all items of item_type in tree_id, across every objectid and offset.

pub fn for_objectid_range( tree_id: u64, item_type: u32, min_objectid: u64, max_objectid: u64, ) -> Self

Return all items of item_type in tree_id whose objectid falls in [min_objectid, max_objectid].

Trait Implementations

impl Clone for SearchKey

fn clone(&self) -> SearchKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchKey

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

Formats the value using the given formatter.