From b2488098b6b9ace682cb48a49219ea37cdfb86c5 Mon Sep 17 00:00:00 2001 From: Tamo Date: Mon, 9 Oct 2023 15:59:07 +0200 Subject: [PATCH] rename the method and add a little bit of documentation --- src/bitmap/ops_with_serialized.rs | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/src/bitmap/ops_with_serialized.rs b/src/bitmap/ops_with_serialized.rs index 5be221b6..2ef48735 100644 --- a/src/bitmap/ops_with_serialized.rs +++ b/src/bitmap/ops_with_serialized.rs @@ -16,7 +16,25 @@ const SERIAL_COOKIE_NO_RUNCONTAINER: u32 = 12346; const SERIAL_COOKIE: u16 = 12347; impl RoaringBitmap { - pub fn union_with_serialized(&mut self, mut reader: impl Read) -> io::Result<()> { + /// Returns the union between a roaring bitmap and a serialized roaring bitmap. + /// + /// Example + /// ======= + /// + /// ``` + /// use roaring::RoaringBitmap; + /// + /// let mut a = RoaringBitmap::from_sorted_iter(0..3000).unwrap(); + /// let b = RoaringBitmap::from_sorted_iter(2000..6000).unwrap(); + /// let union = &a | &b; + /// + /// let mut b_ser = Vec::new(); + /// b.serialize_into(&mut b_ser).unwrap(); + /// a.union_with_serialized_unchecked(&*b_ser).unwrap(); + /// + /// assert_eq!(a, union); + /// ``` + pub fn union_with_serialized_unchecked(&mut self, mut reader: impl Read) -> io::Result<()> { let (size, has_offsets) = { let cookie = reader.read_u32::()?; if cookie == SERIAL_COOKIE_NO_RUNCONTAINER { @@ -122,7 +140,7 @@ mod test { let mut b_ser = Vec::new(); b.serialize_into(&mut b_ser).unwrap(); - a.union_with_serialized(&*b_ser).unwrap(); + a.union_with_serialized_unchecked(&*b_ser).unwrap(); prop_assert_eq!(a, union); } @@ -165,7 +183,7 @@ mod test { let mut b_ser = Vec::new(); b.serialize_into(&mut b_ser).unwrap(); - a.union_with_serialized(&*b_ser).unwrap(); + a.union_with_serialized_unchecked(&*b_ser).unwrap(); assert_eq!(a, union, "When testing: {a:?} | {b:?}"); }