Struct VortexOpenOptions 

pub struct VortexOpenOptions { /* private fields */ }

Open options for a Vortex file reader.

Implementations

impl VortexOpenOptions

pub fn new() -> Self

Create a new VortexOpenOptions with the expected options for the file source.

This should not be used directly, instead public API clients are expected to access either VortexOpenOptions::new() or VortexOpenOptions::memory()

pub fn with_initial_read_size(self, initial_read_size: usize) -> 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_handle(self, handle: Handle) -> Self

Configure a Handle to use for opening the file.

Warning: it is important that the runtime associated with the handle remains alive while the file is being used. If the runtime is dropped, any I/O operations on the file will fail.

We tried to enforce this with Rust lifetimes, but sadly Rust async cannot express scoped futures in a safe way, so we need static lifetimes for now. If you’re interested in the details, see this post.

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.

pub async fn open<S: IntoReadSource>( self, source: S, ) -> VortexResult<VortexFile>

Open a Vortex file using the provided I/O source.

This is the most common way to open a VortexFile and tends to provide the best out-of-the-box performance. The underlying I/O system will continue to be optimised for different file systems and object stores so we encourage users to use this method whenever possible and file issues if they encounter problems.

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

Open a Vortex file from an in-memory buffer.

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

An API for opening a VortexFile using any VortexReadAt implementation.

This is a low-level API and we strongly recommend using VortexOpenOptions::open.

impl VortexOpenOptions

pub async fn open_object_store( self, object_store: &Arc<dyn ObjectStore>, path: &str, ) -> VortexResult<VortexFile>

Trait Implementations

impl Default for VortexOpenOptions

fn default() -> Self

Returns the “default value” for a type.