Struct LearnedSet 

pub struct LearnedSet<K: Key> { /* private fields */ }

A sorted set backed by a learned index.

This is a thin wrapper around LearnedMap<K, ()>.

All operations take &self and are safe to call from multiple threads.

Implementations

impl<K: Key> LearnedSet<K>

pub fn new() -> Self

Create a new empty set.

pub fn with_config(config: Config) -> Self

Create a new set with the given configuration.

pub fn bulk_load(keys: &[K]) -> Result<Self>

Create a set from sorted keys, deduplicating any repeated keys.

Keys must be in ascending order but duplicates are allowed and will be silently removed (sets are idempotent by definition).

Errors

Returns an error if keys is empty (after dedup) or not sorted.

pub fn guard(&self) -> Guard

Acquire an epoch guard.

pub fn pin(&self) -> SetRef<'_, K>

Pin the current epoch and return a SetRef convenience handle.

pub fn insert(&self, key: K, guard: &Guard) -> bool

Insert a key. Returns true if the key was newly inserted.

pub fn remove(&self, key: &K, guard: &Guard) -> bool

Remove a key. Returns true if the key was present.

pub fn contains(&self, key: &K, guard: &Guard) -> bool

Check whether the set contains a key.

pub fn len(&self) -> usize

Return the approximate number of elements in the set.

See LearnedMap::len for details on relaxed-atomic staleness under concurrency.

pub fn is_empty(&self) -> bool

Return true if the set is empty.

Subject to the same relaxed-atomic staleness as len.

pub fn range<'g, R: RangeBounds<K>>( &self, range: R, guard: &'g Guard, ) -> impl Iterator<Item = &'g K>

Return an iterator over keys within the given range, in ascending order.

pub fn first<'g>(&self, guard: &'g Guard) -> Option<&'g K>

Return the first (minimum) key.

pub fn last<'g>(&self, guard: &'g Guard) -> Option<&'g K>

Return the last (maximum) key.

Trait Implementations

impl<K: Debug + Key> Debug for LearnedSet<K>

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

Formats the value using the given formatter.

impl<K: Key> Default for LearnedSet<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Key> Extend<K> for LearnedSet<K>

fn extend<I: IntoIterator<Item = K>>(&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<K: Key> FromIterator<K> for LearnedSet<K>

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

Creates a value from an iterator.