Struct SurrogateBitmap 

pub struct SurrogateBitmap(pub RoaringBitmap);

A dense set of Surrogate values backed by a roaring bitmap.

Used as the prefilter currency flowing between engines in a PhysicalPlan: the planner may embed a SurrogateBitmap produced by one engine sub-plan directly into another engine’s prefilter slot without any ID translation step.

Tuple Fields

0: RoaringBitmap

Implementations

impl SurrogateBitmap

pub fn new() -> Self

Create an empty bitmap.

pub fn contains(&self, surrogate: Surrogate) -> bool

Return true if surrogate is present in the bitmap.

pub fn insert(&mut self, surrogate: Surrogate)

Insert surrogate into the bitmap.

pub fn remove(&mut self, surrogate: Surrogate)

Remove surrogate from the bitmap. No-op when absent.

pub fn len(&self) -> u64

Number of elements in the bitmap.

pub fn is_empty(&self) -> bool

Return true if the bitmap contains no elements.

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

Iterate over the surrogates in ascending order.

impl SurrogateBitmap

pub fn intersect(&self, other: &Self) -> Self

Return the intersection of self and other as a new bitmap.

pub fn union(&self, other: &Self) -> Self

Return the union of self and other as a new bitmap.

pub fn difference(&self, other: &Self) -> Self

Return the set difference self \ other as a new bitmap.

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

Return true if every element of self is also in other.

pub fn intersect_in_place(&mut self, other: &Self)

Mutate self in place to hold only elements also in other.

pub fn union_in_place(&mut self, other: &Self)

Mutate self in place to hold the union with other.

Trait Implementations

impl Clone for SurrogateBitmap

fn clone(&self) -> SurrogateBitmap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurrogateBitmap

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

Formats the value using the given formatter.

impl Default for SurrogateBitmap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SurrogateBitmap

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl FromIterator<Surrogate> for SurrogateBitmap

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

Creates a value from an iterator.

impl<'a> FromMessagePack<'a> for SurrogateBitmap

fn read<R: Read<'a>>(reader: &mut R) -> Result<Self>

Reads the MessagePack representation of this value from the provided reader.

impl PartialEq for SurrogateBitmap

fn eq(&self, other: &SurrogateBitmap) -> 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 Serialize for SurrogateBitmap

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToMessagePack for SurrogateBitmap

fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Writes the MessagePack representation of this value into the provided writer.

impl StructuralPartialEq for SurrogateBitmap