Struct NippyJar

pub struct NippyJar<H = ()> { /* private fields */ }

NippyJar is a specialized storage format designed for immutable data.

Data is organized into a columnar format, enabling column-based compression. Data retrieval entails consulting an offset list and fetching the data from file via mmap.

Implementations

impl NippyJar<()>

pub fn new_without_header(columns: usize, path: &Path) -> Self

Creates a new NippyJar without an user-defined header data.

pub fn load_without_header(path: &Path) -> Result<Self, NippyJarError>

Loads the file configuration and returns Self on a jar without user-defined header data.

impl<H: NippyJarHeader> NippyJar<H>

pub fn new(columns: usize, path: &Path, user_header: H) -> Self

Creates a new NippyJar with a user-defined header data.

pub fn with_zstd(self, use_dict: bool, max_dict_size: usize) -> Self

Adds compression::Zstd compression.

pub fn with_lz4(self) -> Self

Adds compression::Lz4 compression.

pub const fn user_header(&self) -> &H

Gets a reference to the user header.

pub const fn columns(&self) -> usize

Gets total columns in jar.

pub const fn rows(&self) -> usize

Gets total rows in jar.

pub const fn compressor(&self) -> Option<&Compressors>

Gets a reference to the compressor.

pub fn compressor_mut(&mut self) -> Option<&mut Compressors>

Gets a mutable reference to the compressor.

pub fn load(path: &Path) -> Result<Self, NippyJarError>

Loads the file configuration and returns Self.

The user must ensure the header type matches the one used during the jar’s creation.

pub fn load_from_reader<R: Read>(reader: R) -> Result<Self, NippyJarError>

Deserializes an instance of Self from a Read type.

pub fn data_path(&self) -> &Path

Returns the path for the data file

pub fn index_path(&self) -> PathBuf

Returns the path for the index file

pub fn offsets_path(&self) -> PathBuf

Returns the path for the offsets file

pub fn config_path(&self) -> PathBuf

Returns the path for the config file

pub fn delete(self) -> Result<(), NippyJarError>

Deletes from disk this NippyJar alongside every satellite file.

pub fn open_data_reader(&self) -> Result<DataReader, NippyJarError>

Returns a DataReader of the data and offset file

Trait Implementations

impl<H: NippyJarHeader> Debug for NippyJar<H>

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

Formats the value using the given formatter.

impl<'de, H> Deserialize<'de> for NippyJar<H>

where H: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H> Serialize for NippyJar<H>

where H: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.