Struct SearchFilter 

pub struct SearchFilter {
    pub tree_id: u64,
    pub start: Key,
    pub end: Key,
    pub min_transid: u64,
    pub max_transid: u64,
}

Filter specifying which items to return from a tree search.

Filtering works in three stages:

1. Select a tree by tree_id (e.g. root tree, chunk tree, quota tree).
2. Return only items whose compound key (objectid, item_type, offset) falls within the inclusive range [start, end]. Because the key is a compound tuple, the three components of start and end are not independent filters — they form a single ordered bound on the B-tree. This means items with unexpected types can appear if their compound key is between start and end; callbacks should filter on hdr.item_type when they need a single type.
3. Trim results to only include items stored in metadata blocks whose transaction ID falls within [min_transid, max_transid].

Build a filter for common cases with SearchFilter::for_type or SearchFilter::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: a BTRFS_*_TREE_OBJECTID constant from crate::raw.

start: Key

Lower bound of the key range (inclusive).

end: Key

Upper bound of the key range (inclusive).

min_transid: u64

Lower bound on the metadata block transaction ID (inclusive).

max_transid: u64

Upper bound on the metadata block transaction ID (inclusive).

Implementations

impl SearchFilter

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 SearchFilter

fn clone(&self) -> SearchFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchFilter

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

Formats the value using the given formatter.