Struct VortexOpenOptions

pub struct VortexOpenOptions<F: FileType> { /* private fields */ }

Open options for a Vortex file reader.

Implementations

impl VortexOpenOptions<GenericVortexFile>

pub fn file() -> Self

Open a file using the provided VortexReadAt implementation.

pub fn with_initial_read_size(self, initial_read_size: u64) -> Self

Configure the initial read size for the Vortex file.

pub fn with_segment_cache(self, segment_cache: Arc<dyn SegmentCache>) -> Self

Configure a custom SegmentCache.

pub fn without_segment_cache(self) -> Self

Disable segment caching entirely.

pub fn with_io_concurrency(self, io_concurrency: usize) -> Self

pub async fn open_read_at<R: VortexReadAt + Send + Sync>( self, read: R, ) -> VortexResult<VortexFile>

Low-level API for opening any VortexReadAt. Note that the user is responsible for ensuring the VortexReadAt implementation is compatible with the chosen I/O dispatcher.

impl VortexOpenOptions<InMemoryFileType>

pub fn in_memory() -> Self

Create open options for an in-memory Vortex file.

pub async fn open<B: Into<ByteBuffer>>( self, buffer: B, ) -> VortexResult<VortexFile>

Open an in-memory file contained in the provided buffer.

impl<F: FileType> VortexOpenOptions<F>

pub fn with_array_registry(self, registry: Arc<ArrayRegistry>) -> Self

Configure a Vortex array registry.

pub fn with_layout_registry(self, registry: Arc<LayoutRegistry>) -> Self

Configure a Vortex array registry.

pub fn with_file_size(self, file_size: u64) -> Self

Configure a known file size.

This helps to prevent an I/O request to discover the size of the file. Of course, all bets are off if you pass an incorrect value.

pub fn with_dtype(self, dtype: DType) -> Self

Configure a known DType.

If this is provided, then the Vortex file may be opened with fewer I/O requests.

For Vortex files that do not contain a DType, this is required.

pub fn with_footer(self, footer: Footer) -> Self

Configure a known file layout.

If this is provided, then the Vortex file can be opened without performing any I/O. Once open, the Footer can be accessed via crate::VortexFile::footer.

pub fn with_metrics(self, metrics: VortexMetrics) -> Self

Configure a custom VortexMetrics.