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.

All write strategies are restricted to the encodings in the session’s enabled editions.

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. Replacing the strategy does not change the enabled-edition encoding policy.

pub fn buffered_bytes_tracker(&self) -> BufferedBytesTracker

Returns the tracker accounting for bytes that layout strategies are holding but have not yet emitted.

The tracker is shared with the write these options start, so it can be captured before calling Self::write and polled while the write runs. Writer::buffered_bytes exposes the same counter for the push-based API.

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.

pub fn with_metadata_segment( self, key: impl Into<String>, metadata: impl Into<ByteBuffer>, ) -> Self

Add a user-defined metadata segment (keyed, opaque bytes); a repeated key replaces the previous value. Keys and the segment count are validated against MAX_METADATA_*.

pub fn with_metadata_segments<I, K, B>(self, metadata: I) -> Self

where I: IntoIterator<Item = (K, B)>, K: Into<String>, B: Into<ByteBuffer>,

Add user-defined metadata segments to the file.

If a key already exists, the previous segment for that key is replaced.

pub fn validate_metadata(&self) -> VortexResult<()>

Check the configured metadata segments against the MAX_METADATA_* limits.

Self::write performs the same check, but only once the sink is already being written to. Callers that accept metadata from elsewhere (FFI bindings, for example) can use this to reject an invalid set before any bytes are produced.

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.

The set of encodings permitted in the file is snapshotted from the session’s array registry here, so encodings registered after this call are not written.

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.