Struct FileHandle 

pub struct FileHandle {
    inner: Arc<FileHandleInner>,
}

Handle to a SST file.

Fields

inner: Arc<FileHandleInner>

Implementations

impl FileHandle

pub fn new(meta: FileMeta, file_purger: FilePurgerRef) -> FileHandle

Creates a handle sharing the file’s physical state and original statistics.

pub fn region_id(&self) -> RegionId

Returns the region id of the file.

pub(crate) fn is_effective_target_sequence_trusted( &self, target_region_id: RegionId, ) -> bool

Returns whether this file’s row sequences are trusted in the target region.

Foreign files use their target-local sequence barrier; local files require the preserve marker because their physical sequences belong to this region.

pub fn file_id(&self) -> RegionFileId

Returns the cross-region file id.

pub fn index_id(&self) -> RegionIndexId

Returns the RegionIndexId for this file.

pub fn file_path(&self, table_dir: &str, path_type: PathType) -> String

Returns the complete file path of the file.

pub fn time_range(&self) -> FileTimeRange

Returns the time range of the file.

pub fn mark_deleted(&self)

Mark the file as deleted and will delete it on drop asynchronously

pub fn compacting(&self) -> bool

pub fn set_compacting(&self, compacting: bool)

pub fn try_set_compacting(&self) -> bool

Atomically marks this file as compacting if it is currently available.

pub fn index_outdated(&self) -> bool

pub fn set_index_outdated(&self, index_outdated: bool)

pub fn meta_ref(&self) -> &FileMeta

Returns a reference to the FileMeta.

pub fn file_purger(&self) -> FilePurgerRef

pub fn size(&self) -> u64

pub fn index_size(&self) -> u64

pub fn num_rows(&self) -> usize

pub fn level(&self) -> Level

pub fn is_deleted(&self) -> bool

pub(crate) fn primary_key_range( &self, mapper: &PrimaryKeyRangeMapper, ) -> Option<(Bytes, Bytes)>

Returns bounds aligned to the caller’s pinned schema, before any comparison or aggregation. Unknown and invalid statistics cannot exclude possible data.

pub fn raw_primary_key_range(&self) -> Option<(Bytes, Bytes)>

Returns original statistics for metadata hydration, never schema-aligned bounds.

pub(crate) fn set_primary_key_range(&self, primary_key_range: (Bytes, Bytes))

Trait Implementations

impl Clone for FileHandle

fn clone(&self) -> FileHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileHandle

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

Formats the value using the given formatter.

impl Item for FileHandle

fn size(&self) -> usize

Size is used to calculate the cost of merging items.

impl Ranged for FileHandle

type BoundType = Timestamp

fn range(&self) -> (Self::BoundType, Self::BoundType)

Returns the inclusive range of item.

fn overlap(&self, other: &Self) -> bool

fn overlap_inclusive(&self, other: &Self) -> bool

Like overlap, but treats touching boundaries as overlapping (inclusive). Used by find_overlapping_items where shared boundaries count as overlap.