Enum croaring::Portable

pub enum Portable {}

The Portable format is meant to be compatible with other roaring bitmap libraries, such as Go or Java.

Note despite the name, it is not fully portable: it depends on native endianness.

It’s defined here: https://github.com/RoaringBitmap/RoaringFormatSpec

Trait Implementations

impl Deserializer for Portable

fn try_deserialize(buffer: &[u8]) -> Option<(Treemap, usize)>

Try to deserialize a treemap from the beginning of the provided buffer

impl Deserializer for Portable

fn try_deserialize(buffer: &[u8]) -> Option<Bitmap>

Given a serialized bitmap as slice of bytes in portable format, returns a Bitmap instance. See Bitmap::try_deserialize for examples.

unsafe fn try_deserialize_unchecked(buffer: &[u8]) -> Bitmap

Deserialize a bitmap from the beginning of the provided buffer

impl Deserializer for Portable

fn try_deserialize(buffer: &[u8]) -> Option<Bitmap64>

Try to deserialize a bitmap from the beginning of the provided buffer

unsafe fn try_deserialize_unchecked(buffer: &[u8]) -> Bitmap64

Deserialize a bitmap from the beginning of the provided buffer

fn find_end(buffer: &[u8]) -> Option<NonZeroUsize>

Find the end of a serialized bitmap in portable format

impl Serializer for Portable

fn serialize_into_writer<W>(treemap: &Treemap, dst: W) -> Result<usize>

where W: Write,

Serializes a Treemap to a writer in portable format. See Treemap::serialize_into_writer for examples.

fn serialize_into<'a>(treemap: &Treemap, dst: &'a mut Vec<u8>) -> &'a [u8]

Serializes a Treemap to a slice of bytes in portable format. See Treemap::serialize_into for examples.

fn get_serialized_size_in_bytes(treemap: &Treemap) -> usize

Computes the serialized size in bytes of the Treemap in portable format. See Treemap::get_serialized_size_in_bytes for examples.

impl Serializer for Portable

fn serialize_into<'a>(bitmap: &Bitmap64, dst: &'a mut Vec<u8>) -> &'a [u8]

Serialize a bitmap to a slice of bytes in portable format.

See Bitmap64::serialize_into for more details.

fn get_serialized_size_in_bytes(bitmap: &Bitmap64) -> usize

Computes the serialized size in bytes of the Bitmap in portable format. See Bitmap64::get_serialized_size_in_bytes for examples.

impl Serializer for Portable

fn serialize_into<'a>(bitmap: &Bitmap, dst: &'a mut Vec<u8>) -> &'a [u8]

Serializes a bitmap to a slice of bytes in portable format. See Bitmap::serialize_into for examples.

fn get_serialized_size_in_bytes(bitmap: &Bitmap) -> usize

Computes the serialized size in bytes of the Bitmap in portable format. See Bitmap::get_serialized_size_in_bytes for examples.

impl ViewDeserializer for Portable

unsafe fn deserialize_view(data: &[u8]) -> BitmapView<'_>

Read bitmap from a serialized buffer

This is meant to be compatible with the Java and Go versions

Safety

• data must be the result of serializing a roaring bitmap in portable mode (following https://github.com/RoaringBitmap/RoaringFormatSpec), for example, with Bitmap::serialize
• Using this function (or the returned bitmap in any way) may execute unaligned memory accesses