Struct VortexWriteOptions 

pub struct VortexWriteOptions { /* private fields */ }

Configure a new writer, which can eventually be used to write an ArrayStream into a sink that implements VortexWrite.

Unless overridden, the default write strategy will be used with no additional configuration.

Construct with WriteOptionsSessionExt::write_options for normal use so the writer inherits the session’s runtime, array registry, and memory configuration.

Implementations

impl VortexWriteOptions

pub fn new(session: VortexSession) -> Self

Create a new VortexWriteOptions with the given session.

pub fn with_strategy(self, strategy: Arc<dyn LayoutStrategy>) -> Self

Replace the default layout strategy with the provided one.

The strategy controls repartitioning, statistics layout, compression, and leaf segment emission. Use WriteStrategyBuilder when only a small part of the default strategy needs customization.

pub fn exclude_dtype(self) -> Self

Exclude the DType from the Vortex file. You must provide the DType to the reader.

pub fn with_file_statistics(self, file_statistics: Vec<Stat>) -> Self

Configure which statistics to compute at the file level.

Pass an empty vector to omit file-level statistics.

impl VortexWriteOptions

pub fn blocking<B: BlockingRuntime>(self, runtime: &B) -> BlockingWrite<'_, B>

Drop into the blocking writer API using the given runtime.

The returned adapter drives async writer internals on runtime while accepting ordinary std::io::Write sinks and ArrayIterator inputs.

pub async fn write<W: VortexWrite + Unpin, S: ArrayStream + Send + 'static>( self, write: W, stream: S, ) -> VortexResult<WriteSummary>

Write an ArrayStream as a Vortex file.

Note that buffers are flushed as soon as they are available with no buffering, the caller is responsible for deciding how to configure buffering on the underlying Write sink.

pub fn writer<'w, W: VortexWrite + Unpin + 'w>( self, write: W, dtype: DType, ) -> Writer<'w>

Create a push-based Writer that can be used to incrementally write arrays to the file.

Each pushed chunk must have dtype dtype. Call Writer::finish to close the input stream, flush remaining buffers, and receive the WriteSummary.