RoaringValue

Struct RoaringValue 

Source
pub struct RoaringValue { /* private fields */ }
Expand description

Value type for RoaringTreemap in partitioned tables.

This struct provides the bridge between the generic partitioned storage and roaring-specific value operations. It handles:

  • Serialization/deserialization of RoaringTreemap
  • Size queries for segment rolling decisions
  • Version management for future migrations

Implementations§

Source§

impl RoaringValue

Source

pub fn new(bitmap: RoaringTreemap) -> Self

Creates a new RoaringValue from an existing bitmap.

Source

pub fn empty() -> Self

Creates an empty RoaringValue.

Source

pub fn bitmap(&self) -> &RoaringTreemap

Returns a reference to the underlying bitmap.

Source

pub fn bitmap_mut(&mut self) -> &mut RoaringTreemap

Returns a mutable reference to the underlying bitmap.

Source

pub fn into_bitmap(self) -> RoaringTreemap

Consumes the value and returns the underlying bitmap.

Source

pub fn encode(&self) -> Result<Vec<u8>>

Encodes a RoaringTreemap into storage format.

§Arguments
  • bitmap - The roaring bitmap to encode
§Returns

Encoded bytes ready for storage

Source

pub fn encode_bitmap(bitmap: &RoaringTreemap) -> Result<Vec<u8>>

Encodes a RoaringTreemap into storage format.

§Arguments
  • bitmap - The roaring bitmap to encode
§Returns

Encoded bytes ready for storage

Source

pub fn decode(data: &[u8]) -> Result<Self>

Decodes storage bytes into a RoaringValue.

§Arguments
  • data - The encoded value bytes
§Returns

Decoded RoaringValue

Source

pub fn get_serialized_size(&self) -> Result<usize>

Gets the serialized size of a RoaringTreemap.

This size is used by the partition layer to determine when to roll segments based on the configured maximum segment size.

§Arguments
  • bitmap - The roaring bitmap to measure
§Returns

Serialized size in bytes (including version prefix)

Source

pub fn get_serialized_size_for(bitmap: &RoaringTreemap) -> Result<usize>

Gets the serialized size of a RoaringTreemap.

This size is used by the partition layer to determine when to roll segments based on the configured maximum segment size.

§Arguments
  • bitmap - The roaring bitmap to measure
§Returns

Serialized size in bytes (including version prefix)

Source

pub fn from_single(value: u64) -> Self

Creates a RoaringValue from a single value.

Source

pub fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = u64>,

Creates a RoaringValue from an iterator of values.

Source

pub fn len(&self) -> u64

Returns the number of members in the bitmap.

Source

pub fn is_empty(&self) -> bool

Returns true if the bitmap is empty.

Trait Implementations§

Source§

impl Clone for RoaringValue

Source§

fn clone(&self) -> RoaringValue

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RoaringValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RoaringValue

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<RoaringTreemap> for RoaringValue

Source§

fn from(value: RoaringTreemap) -> Self

Converts to this type from the input type.
Source§

impl MergeableValue for RoaringValue

Source§

fn merge(existing: Option<Self>, incoming: Self) -> Self

Merge an incoming value with an existing value (if any).
Source§

impl PartialEq for RoaringValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Value for RoaringValue

Source§

type SelfType<'a> = RoaringValue where Self: 'a

SelfType<'a> must be the same type as Self with all lifetimes replaced with ’a
Source§

type AsBytes<'a> = Vec<u8> where Self: 'a

Source§

fn fixed_width() -> Option<usize>

Width of a fixed type, or None for variable width
Source§

fn from_bytes<'a>(data: &'a [u8]) -> Self::SelfType<'a>
where Self: 'a,

Deserializes data Implementations may return a view over data, or an owned type
Source§

fn as_bytes<'a, 'b: 'a>(value: &'a Self::SelfType<'b>) -> Self::AsBytes<'a>
where Self: 'b,

Serialize the value to a slice
Source§

fn type_name() -> TypeName

Globally unique identifier for this type
Source§

impl StructuralPartialEq for RoaringValue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.