Struct swapvec::SwapVec

pub struct SwapVec<T>where
    for<'a> T: Serialize + Deserialize<'a>,{ /* private fields */ }

An only growing array type which swaps to disk, based on it’s initial configuration.

Create a mutable instance, and then pass iterators or elements to grow it.

let mut bigvec = swapvec::SwapVec::default();
let iterator = (0..9);
bigvec.consume(iterator);
bigvec.push(99);
let new_iterator = bigvec.into_iter();

Implementations

impl<T> SwapVec<T>where for<'a> T: Serialize + Deserialize<'a> + Hash,

pub fn with_config(config: SwapVecConfig) -> Self

Intialize with non-default configuration.

pub fn consume( &mut self, it: impl Iterator<Item = T> ) -> Result<(), SwapVecError>

Give away an entire iterator for consumption.
Might return an error, due to possibly triggered batch flush (IO).

pub fn push(&mut self, element: T) -> Result<(), SwapVecError>

Push a single element
Might return an error, due to possibly triggered batch flush (IO).

pub fn written_to_file(&self) -> bool

Check if a file has been created.
Is false if element count is below swap_after and below batch_size

pub fn file_size(&self) -> Option<Result<u64, SwapVecError>>

Get the file size in bytes of the temporary file. Might do IO and therefore could return some Result.

pub fn batches_written(&self) -> usize

Basically elements pushed // batch_size

Trait Implementations

impl<T: Serialize + for<'a> Deserialize<'a>> Debug for SwapVec<T>

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

Formats the value using the given formatter.

impl<T: Serialize + for<'a> Deserialize<'a>> Default for SwapVec<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Serialize + for<'a> Deserialize<'a> + Hash> IntoIterator for SwapVec<T>

type Item = Result<T, SwapVecError>

The type of the elements being iterated over.

type IntoIter = SwapVecIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.