Struct SChunk 

pub struct SChunk(/* private fields */);

Wrapper to blosc2_schunk

Implementations

impl SChunk

pub fn new(storage: Storage) -> Self

pub fn copy(&self) -> Self

pub fn frame(&self) -> Result<&[u8]>

pub fn append_buffer<T>(&mut self, data: &[T]) -> Result<usize>

Append data to SChunk, returning new number of chunks

pub fn decompress_chunk<T>( &mut self, nchunk: usize, dst: &mut [T], ) -> Result<usize>

Decompress a chunk, returning number of elements of T written to output buffer

pub fn decompress_chunk_vec<T>(&mut self, nchunk: usize) -> Result<Vec<T>>

pub fn set_slice_buffer( &self, start: usize, stop: usize, buf: &[u8], ) -> Result<()>

Set slice buffer

pub fn get_slice_buffer(&self, start: usize, stop: usize) -> Result<Vec<u8>>

Get uncompressed slice of data from start until stop. Returned as bytes, which can be transmuted/casted into the concrete item type. start/stop is by items, not by bytes

pub fn get_slice_buffer_as_type<T>( &self, start: usize, stop: usize, ) -> Result<Vec<T>>

Convenience method to get_slice_buffer which will transmute resulting bytes buffer into Vec<T> for you. NB This will check T is same size as schunk’s typesize so is fairly safe.

pub fn get_chunk(&self, nchunk: usize) -> Result<Chunk>

pub fn into_vec(self) -> Result<Vec<u8>>

Export this SChunk into a buffer

pub fn from_vec(buf: Vec<u8>) -> Result<Self>

Create a Schunk from an owned Vec<u8>. Data will be owned by the Schunk and released via normal Rust semantics.

pub fn is_contiguous(&self) -> bool

Check if storage of Schunk is contiguous.

pub fn typesize(&self) -> usize

Check typesize

pub fn compression_ratio(&self) -> f32

Compression ratio of the Schunk

pub fn n_chunks(&self) -> usize

Number of chunks

pub fn chunk_shape(&self) -> usize

Chunk shape

pub fn blocksize(&self) -> usize

blocksize

pub fn nbytes(&self) -> usize

Count of uncompressed bytes

pub fn cbytes(&self) -> usize

Count of compressed bytes

pub fn path(&self) -> Option<PathBuf>

Path where the Schunk is stored, if file backed.

pub fn len(&self) -> usize

Returns under of elements in Schunk (nbytes / typesize)

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for SChunk

fn clone(&self) -> SChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for SChunk

fn drop(&mut self)

Executes the destructor for this type.

impl Write for SChunk

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl Send for SChunk