Struct ObjectWriterBuilder 

pub struct ObjectWriterBuilder {
    file_compression_type: FileCompressionType,
    location: Path,
    object_store: Arc<dyn ObjectStore>,
    buffer_size: Option<usize>,
}

A builder for an [AsyncWrite] that writes to an object store location.

This can be used to specify file compression on the writer. The writer will have a default buffer size unless altered. The specific default size is chosen by [BufWriter::new].

We drop the AbortableWrite struct and the writer will not try to cleanup on failure. Users can configure automatic cleanup with their cloud provider.

Fields

file_compression_type: FileCompressionType

Compression type for object writer.

location: Path

Output path

object_store: Arc<dyn ObjectStore>

The related store that handles the given path

buffer_size: Option<usize>

The size of the buffer for the object writer.

Implementations

impl ObjectWriterBuilder

pub fn new( file_compression_type: FileCompressionType, location: &Path, object_store: Arc<dyn ObjectStore>, ) -> Self

Create a new ObjectWriterBuilder for the specified path and compression type.

pub fn set_buffer_size(&mut self, buffer_size: Option<usize>)

Set buffer size in bytes for object writer.

Example

let mut builder = ObjectWriterBuilder::new(compression_type, &location, object_store);
builder.set_buffer_size(Some(20 * 1024 * 1024)); //20 MiB
assert_eq!(
    builder.get_buffer_size(),
    Some(20 * 1024 * 1024),
    "Internal error: Builder buffer size doesn't match"
);

pub fn with_buffer_size(self, buffer_size: Option<usize>) -> Self

Set buffer size in bytes for object writer, returning the builder.

Example

let builder = ObjectWriterBuilder::new(compression_type, &location, object_store)
    .with_buffer_size(Some(20 * 1024 * 1024)); //20 MiB
assert_eq!(
    builder.get_buffer_size(),
    Some(20 * 1024 * 1024),
    "Internal error: Builder buffer size doesn't match"
);

pub fn get_buffer_size(&self) -> Option<usize>

Currently specified buffer size in bytes.

pub fn build(self) -> Result<Box<dyn AsyncWrite + Send + Unpin>>

Return a writer object that writes to the object store location.

If a buffer size has not been set, the default buffer buffer size will be used.

Errors

If there is an error applying the compression type.

Trait Implementations

impl Debug for ObjectWriterBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.