pub struct VortexFile { /* private fields */ }
Expand description
Represents a Vortex file, providing access to its metadata and content.
A VortexFile
is created by opening a Vortex file using VortexOpenOptions
.
It provides methods for accessing file metadata (such as row count, data type, and statistics)
and for initiating scans to read the file’s contents.
Implementations§
Source§impl VortexFile
impl VortexFile
Returns a reference to the file’s footer, which contains metadata and layout information.
Sourcepub fn file_stats(&self) -> Option<&Arc<[StatsSet]>>
pub fn file_stats(&self) -> Option<&Arc<[StatsSet]>>
Returns the file’s statistics, if available.
Statistics can be used for query optimization and data exploration.
Sourcepub fn metrics(&self) -> &VortexMetrics
pub fn metrics(&self) -> &VortexMetrics
Returns a reference to the file’s metrics.
Sourcepub fn segment_source(&self) -> Arc<dyn SegmentSource>
pub fn segment_source(&self) -> Arc<dyn SegmentSource>
Create a new segment source for reading from the file.
This may spawn a background I/O driver that will exit when the returned segment source is dropped.
Sourcepub fn layout_reader(&self) -> VortexResult<Arc<dyn LayoutReader>>
pub fn layout_reader(&self) -> VortexResult<Arc<dyn LayoutReader>>
Create a new layout reader for the file.
Sourcepub fn scan(&self) -> VortexResult<ScanBuilder>
pub fn scan(&self) -> VortexResult<ScanBuilder>
Initiate a scan of the file, returning a builder for configuring the scan.
Trait Implementations§
Source§impl Clone for VortexFile
impl Clone for VortexFile
Source§fn clone(&self) -> VortexFile
fn clone(&self) -> VortexFile
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl !Freeze for VortexFile
impl !RefUnwindSafe for VortexFile
impl Send for VortexFile
impl Sync for VortexFile
impl Unpin for VortexFile
impl !UnwindSafe for VortexFile
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out
indicating that a T
is niched.