lifetime and roaring doc (#106)

* lifetime and roaring doc

* Update src/roaring.rs

* lifetime and roaring

* Update src/lib.rs

---------

Co-authored-by: Nate Nethercott <nathaniel.nethercott@mistral.ai>

Author: jianshu93

Cargo.toml

@@ -45,6 +45,7 @@ once_cell = { version = "1.21.3", optional = true }
 tempfile = { version = "3.21.0", optional = true }
 parking_lot = { version = "0.12.4", optional = true }
 
+
 [target.'cfg(not(windows))'.dependencies]
 madvise = "0.1.0"
 

src/lib.rs

@@ -102,6 +102,7 @@ use metadata::{Metadata, MetadataCodec};
 use node::{Node, NodeCodec};
 use node_id::{NodeId, NodeMode};
 pub use reader::{QueryBuilder, Reader};
+pub use roaring::RoaringBitmapCodec;
 pub use writer::{HannoyBuilder, Writer};
 
 /// The set of types used by the [`Distance`] trait.

src/roaring.rs

@@ -3,6 +3,14 @@ use std::borrow::Cow;
 use heed::BoxedError;
 use roaring::RoaringBitmap;
 
+/// A `heed` codec for `roaring::RoaringBitmap`.
+///
+/// Encodes via [`RoaringBitmap::serialize_into`] and decodes via
+/// [`RoaringBitmap::deserialize_unchecked_from`].
+///
+/// # Safety
+/// Decoding trusts the bytes. Only use with data written by this codec or
+/// switch to [`RoaringBitmap::deserialize_from`] if you need validation.
 pub struct RoaringBitmapCodec;
 
 impl heed::BytesDecode<'_> for RoaringBitmapCodec {
@@ -16,7 +24,7 @@ impl heed::BytesDecode<'_> for RoaringBitmapCodec {
 impl heed::BytesEncode<'_> for RoaringBitmapCodec {
     type EItem = RoaringBitmap;
 
-    fn bytes_encode(item: &Self::EItem) -> Result<Cow<[u8]>, BoxedError> {
+    fn bytes_encode(item: &Self::EItem) -> Result<Cow<'_, [u8]>, BoxedError> {
         let mut bytes = Vec::with_capacity(item.serialized_size());
         item.serialize_into(&mut bytes)?;
         Ok(Cow::Owned(bytes))

src/unaligned_vector/binary.rs

@@ -15,7 +15,7 @@ const PACKED_WORD_BYTES: usize = std::mem::size_of::<BitPackedWord>();
 pub enum Binary {}
 
 impl UnalignedVectorCodec for Binary {
-    fn from_bytes(bytes: &[u8]) -> Result<Cow<UnalignedVector<Self>>, SizeMismatch> {
+    fn from_bytes(bytes: &[u8]) -> Result<Cow<'_, UnalignedVector<Self>>, SizeMismatch> {
         let rem = bytes.len() % PACKED_WORD_BYTES;
         if rem == 0 {
             // safety: `UnalignedVector` is transparent

src/unaligned_vector/binary_quantized.rs

@@ -15,7 +15,7 @@ const QUANTIZED_WORD_BYTES: usize = std::mem::size_of::<QuantizedWord>();
 pub enum BinaryQuantized {}
 
 impl UnalignedVectorCodec for BinaryQuantized {
-    fn from_bytes(bytes: &[u8]) -> Result<Cow<UnalignedVector<Self>>, SizeMismatch> {
+    fn from_bytes(bytes: &[u8]) -> Result<Cow<'_, UnalignedVector<Self>>, SizeMismatch> {
         let rem = bytes.len() % QUANTIZED_WORD_BYTES;
         if rem == 0 {
             // safety: `UnalignedVector` is transparent

src/unaligned_vector/f32.rs

@@ -10,7 +10,7 @@ use super::{SizeMismatch, UnalignedVector, UnalignedVectorCodec};
 
 impl UnalignedVectorCodec for f32 {
     /// Creates an unaligned slice of f32 wrapper from a slice of bytes.
-    fn from_bytes(bytes: &[u8]) -> Result<Cow<UnalignedVector<Self>>, SizeMismatch> {
+    fn from_bytes(bytes: &[u8]) -> Result<Cow<'_, UnalignedVector<Self>>, SizeMismatch> {
         let rem = bytes.len() % size_of::<f32>();
         if rem == 0 {
             // safety: `UnalignedF32Slice` is transparent
@@ -22,7 +22,7 @@ impl UnalignedVectorCodec for f32 {
 
     /// Creates an unaligned slice of f32 wrapper from a slice of f32.
     /// The slice is already known to be of the right length.
-    fn from_slice(slice: &[f32]) -> Cow<UnalignedVector<Self>> {
+    fn from_slice(slice: &[f32]) -> Cow<'_, UnalignedVector<Self>> {
         Self::from_bytes(cast_slice(slice)).unwrap()
     }
 

src/unaligned_vector/mod.rs

@@ -21,11 +21,11 @@ mod binary_quantized_test;
 pub trait UnalignedVectorCodec: std::borrow::ToOwned + Sized {
     /// Creates an unaligned vector from a slice of bytes.
     /// Don't allocate.
-    fn from_bytes(bytes: &[u8]) -> Result<Cow<UnalignedVector<Self>>, SizeMismatch>;
+    fn from_bytes(bytes: &[u8]) -> Result<Cow<'_, UnalignedVector<Self>>, SizeMismatch>;
 
     /// Creates an unaligned vector from a slice of f32.
     /// May allocate depending on the codec.
-    fn from_slice(slice: &[f32]) -> Cow<UnalignedVector<Self>>;
+    fn from_slice(slice: &[f32]) -> Cow<'_, UnalignedVector<Self>>;
 
     /// Creates an unaligned slice of f32 wrapper from a slice of f32.
     /// The slice is already known to be of the right length.
@@ -62,13 +62,13 @@ pub struct UnalignedVector<Codec: UnalignedVectorCodec> {
 impl<Codec: UnalignedVectorCodec> UnalignedVector<Codec> {
     /// Creates an unaligned vector from a slice of bytes.
     /// Don't allocate.
-    pub fn from_bytes(bytes: &[u8]) -> Result<Cow<UnalignedVector<Codec>>, SizeMismatch> {
+    pub fn from_bytes(bytes: &[u8]) -> Result<Cow<'_, UnalignedVector<Codec>>, SizeMismatch> {
         Codec::from_bytes(bytes)
     }
 
     /// Creates an unaligned vector from a slice of f32.
     /// May allocate depending on the codec.
-    pub fn from_slice(slice: &[f32]) -> Cow<UnalignedVector<Codec>> {
+    pub fn from_slice(slice: &[f32]) -> Cow<'_, UnalignedVector<Codec>> {
         Codec::from_slice(slice)
     }