Struct CodecOptions 

pub struct CodecOptions { /* private fields */ }

Codec options for encoding/decoding.

The default values are:

• validate_checksums: true
• store_empty_chunks: false
• concurrent_target: number of threads available to Rayon
• chunk_concurrent_minimum: 4
• experimental_partial_encoding: false

Implementations

impl CodecOptions

pub fn validate_checksums(&self) -> bool

Return the validate checksums setting.

pub fn set_validate_checksums(&mut self, validate_checksums: bool) -> &mut Self

Set whether or not to validate checksums.

pub fn with_validate_checksums(self, validate_checksums: bool) -> Self

Set whether or not to validate checksums.

pub fn store_empty_chunks(&self) -> bool

Return the store empty chunks setting.

pub fn set_store_empty_chunks(&mut self, store_empty_chunks: bool) -> &mut Self

Set whether or not to store empty chunks.

pub fn with_store_empty_chunks(self, store_empty_chunks: bool) -> Self

Set whether or not to store empty chunks.

pub fn concurrent_target(&self) -> usize

Return the concurrent target.

pub fn set_concurrent_target(&mut self, concurrent_target: usize) -> &mut Self

Set the concurrent target.

pub fn with_concurrent_target(self, concurrent_target: usize) -> Self

Set the concurrent target.

pub fn chunk_concurrent_minimum(&self) -> usize

Return the chunk concurrent minimum.

Array operations involving multiple chunks can tune the chunk and codec concurrency to improve performance/reduce memory usage. This option sets the preferred minimum chunk concurrency. The concurrency of internal codecs is adjusted to accomodate for the chunk concurrency in accordance with the concurrent target.

pub fn set_chunk_concurrent_minimum( &mut self, chunk_concurrent_minimum: usize, ) -> &mut Self

Set the chunk concurrent minimum.

pub fn with_chunk_concurrent_minimum( self, chunk_concurrent_minimum: usize, ) -> Self

Set the chunk concurrent minimum.

pub fn experimental_partial_encoding(&self) -> bool

Return the experimental partial encoding setting.

pub fn set_experimental_partial_encoding( &mut self, experimental_partial_encoding: bool, ) -> &mut Self

Set whether or not to use experimental partial encoding.

pub fn with_experimental_partial_encoding( self, experimental_partial_encoding: bool, ) -> Self

Set whether or not to use experimental partial encoding.

Trait Implementations

impl Clone for CodecOptions

fn clone(&self) -> CodecOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodecOptions

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

Formats the value using the given formatter.

impl Default for CodecOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for CodecOptions