Struct IntVectorWriter 

pub struct IntVectorWriter { /* private fields */ }

A buffered file writer compatible with the serialization format of IntVector.

When the writer goes out of scope, the internal buffer is flushed, the file is closed, and all errors are ignored. Call IntVectorWriter::close explicitly to handle the errors.

Examples

use simple_sds_sbwt::int_vector::{IntVector, IntVectorWriter};
use simple_sds_sbwt::ops::{Vector, Access, Push};
use simple_sds_sbwt::serialize;
use std::fs;

let filename = serialize::temp_file_name("int-vector-writer");
let mut writer = IntVectorWriter::new(&filename, 13).unwrap();
assert!(writer.is_empty());
writer.push(123); writer.push(456); writer.push(789);
assert_eq!(writer.len(), 3);
writer.close().unwrap();

let v: IntVector = serialize::load_from(&filename).unwrap();
assert_eq!(v.len(), 3);
assert_eq!(v.get(0), 123); assert_eq!(v.get(1), 456); assert_eq!(v.get(2), 789);
fs::remove_file(&filename).unwrap();

Implementations

impl IntVectorWriter

pub fn new<P: AsRef<Path>>(filename: P, width: usize) -> Result<IntVectorWriter>

Creates an empty vector stored in the specified file with the default buffer size.

If the file already exists, it will be overwritten.

Arguments

• filename: Name of the file.
• width: Width of each item in bits.

Errors

Returns an error of the kind ErrorKind::Other if the width is invalid. Any I/O errors will be passed through.

pub fn with_buf_len<P: AsRef<Path>>( filename: P, width: usize, buf_len: usize, ) -> Result<IntVectorWriter>

Creates an empty vector stored in the specified file with user-defined buffer size.

If the file already exists, it will be overwritten. Actual buffer size may be slightly higher than requested.

Arguments

• filename: Name of the file.
• width: Width of each item in bits.
• buf_len: Buffer size in items.

Errors

Returns an error of the kind ErrorKind::Other if the width is invalid. Any I/O errors will be passed through.

Panics

May panic if buffer length would exceed the maximum length.

pub fn filename(&self) -> &Path

Returns the name of the file.

pub fn is_open(&self) -> bool

Returns true if the file is open for writing.

pub fn close(&mut self) -> Result<()>

Flushes the buffer, writes the header, and closes the file.

No effect if the file is closed.

Errors

Any I/O errors will be passed through.

Trait Implementations

impl Debug for IntVectorWriter

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

Formats the value using the given formatter.

impl Drop for IntVectorWriter

fn drop(&mut self)

Executes the destructor for this type.

impl Extend<u16> for IntVectorWriter

fn extend<I: IntoIterator<Item = u16>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u32> for IntVectorWriter

fn extend<I: IntoIterator<Item = u32>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u64> for IntVectorWriter

fn extend<I: IntoIterator<Item = u64>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u8> for IntVectorWriter

fn extend<I: IntoIterator<Item = u8>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<usize> for IntVectorWriter

fn extend<I: IntoIterator<Item = usize>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Push for IntVectorWriter

fn push(&mut self, value: <Self as Vector>::Item)

Appends an item to the vector.

impl Vector for IntVectorWriter

type Item = u64

The type of the items in the vector.

fn len(&self) -> usize

Returns the number of items in the vector.

fn width(&self) -> usize

Returns the width of of an item in bits.

fn max_len(&self) -> usize

Returns the maximum length of the vector.

fn is_empty(&self) -> bool

Returns true if the vector is empty.