Struct Splinter

pub struct Splinter { /* private fields */ }

An owned, compressed bitmap for u32 keys

Implementations

impl Splinter

pub fn from_slice(data: &[u32]) -> Self

pub fn from_bytes<T: AsRef<[u8]>>(data: T) -> Result<Self, Culprit<DecodeErr>>

pub fn is_empty(&self) -> bool

Returns true if the splinter is empty.

Examples

let mut splinter = Splinter::default();
assert!(splinter.is_empty());
splinter.insert(1);
assert!(!splinter.is_empty());

pub fn contains(&self, key: u32) -> bool

Returns true if the splinter contains the given key.

Examples

let mut splinter = Splinter::default();
splinter.insert(1);
splinter.insert(3);

assert!(splinter.contains(1));
assert!(!splinter.contains(2));
assert!(splinter.contains(3));

pub fn cardinality(&self) -> usize

Calculates the total number of values stored in the set.

Examples

let mut splinter = Splinter::default();
splinter.insert(6);
splinter.insert(1);
splinter.insert(3);

assert_eq!(3, splinter.cardinality());

pub fn iter(&self) -> impl Iterator<Item = u32> + '_

Returns an sorted Iterator over all keys.

Examples

let mut splinter = Splinter::default();
splinter.insert(6);
splinter.insert(1);
splinter.insert(3);

assert_eq!(&[1, 3, 6], &*splinter.iter().collect::<Vec<_>>());

pub fn insert(&mut self, key: u32) -> bool

Attempts to insert a key into the Splinter, returning true if a key was inserted

pub fn serialize<B: BufMut>(&self, out: &mut B) -> usize

pub fn serialize_to_bytes(&self) -> Bytes

pub fn serialize_to_splinter_ref(&self) -> SplinterRef<Bytes>

pub fn last(&self) -> Option<u32>

Returns the last key in the set

Examples

let mut splinter = Splinter::default();

assert_eq!(None, splinter.last());
splinter.insert(6);
splinter.insert(1);
splinter.insert(3);
assert_eq!(Some(6), splinter.last());

Trait Implementations

impl Clone for Splinter

fn clone(&self) -> Splinter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: AsRef<[u8]>> Cut<SplinterRef<T>> for Splinter

type Output = Splinter

fn cut(&mut self, rhs: &SplinterRef<T>) -> Self::Output

Returns the intersection between self and other while removing the intersection from self

impl Cut for Splinter

type Output = Splinter

fn cut(&mut self, rhs: &Self) -> Self::Output

Returns the intersection between self and other while removing the intersection from self

impl Debug for Splinter

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

Formats the value using the given formatter.

impl Default for Splinter

fn default() -> Splinter

Returns the “default value” for a type.

impl<T: AsRef<[u8]>> From<SplinterRef<T>> for Splinter

fn from(value: SplinterRef<T>) -> Self

Converts to this type from the input type.

impl<K: Into<u32>> FromIterator<K> for Splinter

fn from_iter<T: IntoIterator<Item = K>>(iter: T) -> Self

Creates a value from an iterator.

impl<T: AsRef<[u8]>> Intersection<Splinter> for SplinterRef<T>

type Output = Splinter

fn intersection(&self, rhs: &Splinter) -> Self::Output

Returns the intersection between self and other

impl<T: AsRef<[u8]>> Intersection<SplinterRef<T>> for Splinter

type Output = Splinter

fn intersection(&self, rhs: &SplinterRef<T>) -> Self::Output

Returns the intersection between self and other

impl Intersection for Splinter

type Output = Splinter

fn intersection(&self, rhs: &Self) -> Self::Output

Returns the intersection between self and other

impl<T: AsRef<[u8]>> Merge<SplinterRef<T>> for Splinter

fn merge(&mut self, rhs: &SplinterRef<T>)

Merges rhs into self

impl Merge for Splinter

fn merge(&mut self, rhs: &Self)

Merges rhs into self

impl<T: AsRef<[u8]>> PartialEq<Splinter> for SplinterRef<T>

fn eq(&self, other: &Splinter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: AsRef<[u8]>> PartialEq<SplinterRef<T>> for Splinter

fn eq(&self, other: &SplinterRef<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Splinter

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: AsRef<[u8]>> Union<Splinter> for SplinterRef<T>

type Output = Splinter

fn union(&self, rhs: &Splinter) -> Self::Output

Returns the union between self and other

impl<T: AsRef<[u8]>> Union<SplinterRef<T>> for Splinter

type Output = Splinter

fn union(&self, rhs: &SplinterRef<T>) -> Self::Output

Returns the union between self and other

impl Union for Splinter

type Output = Splinter

fn union(&self, rhs: &Self) -> Self::Output

Returns the union between self and other