Struct csx64::asm::binary_set::BinarySet

pub struct BinarySet { /* fields omitted */ }

An appendonly set of auto-overlapping binary slices.

In use, you add binary slices one at a time and it will attempt to create maximum overlapping. Currently, it only guarantees that supersets and subsets will overlap. It’s theoretically possible to do cross-slice overlapping, but this would be complex and expensive.

Slices added to the set are guaranteed to remain in insertion order. Moreover, the collection is appendonly, so once a slice is added it will remain at that index. Iteration is guaranteed to maintain this ordering.

Example

let mut b = BinarySet::new();
b.add([1, 2, 3, 4].as_ref());     // insert first slice (backed by itself)
b.add(vec![2, 3]);                // this one will overlap with previous
assert_eq!(b.bytes(), 6);         // 6 bytes are stored (slices)
assert_eq!(b.backing_bytes(), 4); // using only 4 backing bytes (internal data)

Implementations

impl BinarySet

pub fn new() -> Self

Constructs an empty set.

pub fn add<'a, T>(&mut self, value: T) -> usize where
    T: Into<Cow<'a, [u8]>>, 

Adds the specified slice to the set, panicing if empty. If an equivalent slice already exists, does nothing, otherwise adds value as a new slice. Returns the index of the pre-existing or new slice.

pub fn clear(&mut self)

Removes all content from the set. This is the only non-appendonly operation, and is just meant to support resource reuse.

pub fn len(&self) -> usize

Gets the number of slices contained in the set.

pub fn is_empty(&self) -> bool

Checks if the set is empty.

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

Iterates over all of the slices contained in the set.

pub fn get(&self, index: usize) -> Option<&[u8]>

Gets the slice at the specified index, or None if out of bounds.

pub fn bytes(&self) -> usize

Gets the total number of bytes from distinct slices that were added to the set.

pub fn backing_bytes(&self) -> usize

Gets the total number of bytes backing the stored slices. This is never larger than bytes.

pub fn decompose(self) -> (Vec<Vec<u8>>, Vec<SliceInfo>)

Gets the collection of backing arrays and the collection of slices.

Trait Implementations

impl BinaryRead for BinarySet

fn bin_read<F: Read>(f: &mut F) -> Result<BinarySet>

impl BinaryWrite for BinarySet

fn bin_write<F: Write>(&self, f: &mut F) -> Result<()>

impl Clone for BinarySet

fn clone(&self) -> BinarySet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BinarySet

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

Formats the value using the given formatter.

impl Default for BinarySet

fn default() -> BinarySet

Returns the “default value” for a type.