Struct BlockedVec 

pub struct BlockedVec { /* private fields */ }

A vector of blocks.

See the module documentation for details.

Implementations

impl BlockedVec

pub fn new() -> Self

Creates a new BlockedVec.

Panics

Panics if the queried page size cannot be made into a layout.

pub fn new_paged(page_layout: Layout) -> Self

Creates a new BlockedVec with a given page layout.

pub fn with_len(len: usize) -> Self

Creates a new BlockedVec with an initial length, with the cursor placed at the front.

Panics

Panics if the queried page size cannot be made into a layout.

pub fn with_len_paged(len: usize, page_layout: Layout) -> Self

Creates a new BlockedVec with a given page layout and an initial length, with the cursor placed at the front.

pub fn len(&self) -> usize

Returns the length of this BlockedVec.

pub fn is_empty(&self) -> bool

Checks if this BlockedVec is empty.

pub fn extend(&mut self, additional: usize)

Extend the BlockedVec, with the possible additional areas filled with zero.

Panics

Panics if the seeker or blocks are inconsistent.

pub fn append_vectored(&mut self, buf: &mut [impl IoSlice<'_>]) -> usize

Append a bunch of buffers to the BlockedVec.

Returns

The actual length of the buffers appended.

Panics

Panics if the seeker is inconsistent.

pub fn append(&mut self, buf: &[u8]) -> usize

Append a buffer to the BlockedVec.

Returns

The actual length of the buffer appended.

pub fn read_vectored(&mut self, buf: &mut [impl IoSliceMut<'_>]) -> usize

Like read, except that it reads into a slice of buffers.

pub fn read_at_vectored( &self, pos: usize, buf: &mut [impl IoSliceMut<'_>], ) -> usize

Like read_at, except that it reads into a slice of buffers.

pub fn read(&mut self, buf: &mut [u8]) -> usize

Pull some bytes from this BlockedVec into the specified buffer, returning how many bytes were read.

pub fn read_at(&self, pos: usize, buf: &mut [u8]) -> usize

Pull some bytes from this BlockedVec into the specified buffer at a specified position, returning how many bytes were read.

pub fn write_vectored(&mut self, buf: &mut [impl IoSlice<'_>]) -> usize

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

pub fn write_at_vectored( &mut self, pos: usize, buf: &mut [impl IoSlice<'_>], ) -> usize

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

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

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

pub fn write_at(&mut self, pos: usize, buf: &[u8]) -> usize

Write a buffer into this writer at a specified position, returning how many bytes were written.

pub fn seek(&mut self, pos: SeekFrom) -> Option<usize>

Seek to an offset, in bytes, in this BlockedVec.

pub fn truncate(&mut self, len: usize) -> bool

Shortens this BlockedVec to the specified length.

pub fn resize(&mut self, new_len: usize)

Resizes the BlockedVec in-place so that len is equal to new_len, with the possible additional area filled with zero.

pub fn iter(&self) -> BlockIter<'_>

Returns the iterator of blocks (i.e. byte slices).

pub fn iter_mut(&mut self) -> BlockIterMut<'_>

Returns the mutable iterator of blocks (i.e. byte slices).

pub fn bytes(&self) -> impl Iterator<Item = u8> + Clone + Debug + '_

Returns every byte of this BlockedVec.

pub fn range<R>(&self, range: R) -> RangeIter<'_>

where R: RangeBounds<usize>,

Returns the iterator of blocks (i.e. byte slices) in a selected range.

The possible blocks parts that are out of range are not returned.

Examples

use std::alloc::Layout;
use blocked_vec::BlockedVec;

let layout = Layout::new::<[u8; 4]>();
// Allocated 4 pages at one time, thus continuous.
let vec = BlockedVec::with_len_paged(16, layout);
let mut range = vec.range(7..14);
assert_eq!(range.next(), Some(&[0u8; 7] as &[u8]));
assert_eq!(range.next(), None);

// Allocated 4 pages independently, thus discrete.
let mut vec = BlockedVec::with_len_paged(4, layout);
vec.append(&[1; 4]);
vec.append(&[2; 4]);
vec.append(&[3; 4]);

let mut range = vec.range(7..14);
assert_eq!(range.next(), Some(&[1u8; 1] as &[u8]));
assert_eq!(range.next(), Some(&[2u8; 4] as &[u8]));
assert_eq!(range.next(), Some(&[3u8; 2] as &[u8]));
assert_eq!(range.next(), None);

pub fn range_mut<R>(&mut self, range: R) -> RangeIterMut<'_>

where R: RangeBounds<usize>,

Returns the mutable iterator of blocks (i.e. byte slices) in a selected range.

The possible blocks parts that are out of range are not returned.

Examples

use std::alloc::Layout;
use blocked_vec::BlockedVec;

let layout = Layout::new::<[u8; 4]>();
// Allocated 4 pages at one time, thus continuous.
let mut vec = BlockedVec::with_len_paged(16, layout);
let mut range = vec.range_mut(7..14);
assert_eq!(range.next(), Some(&mut [0u8; 7] as &mut [u8]));
assert_eq!(range.next(), None);

// Allocated 4 pages independently, thus discrete.
let mut vec = BlockedVec::with_len_paged(4, layout);
vec.append(&[1; 4]);
vec.append(&[2; 4]);
vec.append(&[3; 4]);

let mut range = vec.range_mut(7..14);
assert_eq!(range.next(), Some(&mut [1u8; 1] as &mut [u8]));
assert_eq!(range.next(), Some(&mut [2u8; 4] as &mut [u8]));
assert_eq!(range.next(), Some(&mut [3u8; 2] as &mut [u8]));
assert_eq!(range.next(), None);

Trait Implementations

impl Clone for BlockedVec

fn clone(&self) -> BlockedVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockedVec

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

Formats the value using the given formatter.

impl Default for BlockedVec

Available on crate feature std only.

fn default() -> Self

Returns the “default value” for a type.

impl Read for BlockedVec

Available on crate feature std only.

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl Seek for BlockedVec

Available on crate feature std only.

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl Write for BlockedVec

Available on crate feature std only.

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

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

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

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

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

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

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.