perf: (breaking change) remove excessive cloning in btreemap.insert

benchmarks/compare/canbench_results.yml

@@ -2,21 +2,21 @@ benches:
   read_chunks_btreemap_1:
     total:
       calls: 1
-      instructions: 1219162510
-      heap_increase: 3233
+      instructions: 799994339
+      heap_increase: 1635
       stable_memory_increase: 1665
     scopes: {}
   read_chunks_btreemap_1k:
     total:
       calls: 1
-      instructions: 5415231039
-      heap_increase: 1604
+      instructions: 4994472213
+      heap_increase: 1602
       stable_memory_increase: 1665
     scopes: {}
   read_chunks_btreemap_1m:
     total:
       calls: 1
-      instructions: 134599901409
+      instructions: 133159275732
       heap_increase: 1892
       stable_memory_increase: 3201
     scopes: {}
@@ -44,42 +44,42 @@ benches:
   read_chunks_vec_1:
     total:
       calls: 1
-      instructions: 1363286421
+      instructions: 1363286413
       heap_increase: 3202
       stable_memory_increase: 1665
     scopes: {}
   read_chunks_vec_1k:
     total:
       calls: 1
-      instructions: 1378474867
+      instructions: 1378477856
       heap_increase: 3200
       stable_memory_increase: 1665
     scopes: {}
   read_chunks_vec_1m:
     total:
       calls: 1
-      instructions: 4721968950
+      instructions: 4724968939
       heap_increase: 3784
       stable_memory_increase: 1665
     scopes: {}
   write_chunks_btreemap_1:
     total:
       calls: 1
-      instructions: 1069802998
-      heap_increase: 3233
+      instructions: 650634827
+      heap_increase: 1635
       stable_memory_increase: 1665
     scopes: {}
   write_chunks_btreemap_1k:
     total:
       calls: 1
-      instructions: 4915151136
-      heap_increase: 1604
+      instructions: 4494392310
+      heap_increase: 1602
       stable_memory_increase: 1665
     scopes: {}
   write_chunks_btreemap_1m:
     total:
       calls: 1
-      instructions: 90653823620
+      instructions: 89213197943
       heap_increase: 1892
       stable_memory_increase: 3201
     scopes: {}
@@ -107,21 +107,21 @@ benches:
   write_chunks_vec_1:
     total:
       calls: 1
-      instructions: 1257790953
+      instructions: 1257790959
       heap_increase: 3202
       stable_memory_increase: 1665
     scopes: {}
   write_chunks_vec_1k:
     total:
       calls: 1
-      instructions: 1272012661
+      instructions: 1272015664
       heap_increase: 3200
       stable_memory_increase: 1665
     scopes: {}
   write_chunks_vec_1m:
     total:
       calls: 1
-      instructions: 3712427298
+      instructions: 3715427301
       heap_increase: 3784
       stable_memory_increase: 1665
     scopes: {}

benchmarks/src/vec.rs

@@ -33,6 +33,11 @@ impl<const N: usize> Storable for UnboundedVecN<N> {
         Cow::Owned(self.0.clone())
     }
 
+    #[inline]
+    fn into_bytes(self) -> Vec<u8> {
+        self.0
+    }
+
     #[inline]
     fn from_bytes(bytes: Cow<[u8]>) -> Self {
         Self(bytes.into_owned())
@@ -75,6 +80,11 @@ impl<const N: usize> Storable for BoundedVecN<N> {
         Cow::Owned(self.0.clone())
     }
 
+    #[inline]
+    fn into_bytes(self) -> Vec<u8> {
+        self.0
+    }
+
     #[inline]
     fn from_bytes(bytes: Cow<[u8]>) -> Self {
         Self(bytes.into_owned())

benchmarks/vec/canbench_results.yml

@@ -107,7 +107,7 @@ benches:
   vec_insert_u64:
     total:
       calls: 1
-      instructions: 5869519
+      instructions: 5359519
       heap_increase: 0
       stable_memory_increase: 1
     scopes: {}

docs/src/schema-upgrades.md

@@ -19,6 +19,11 @@ impl Storable for Asset {
         Cow::Owned(bytes)
     }
 
+    fn into_bytes(self) -> Vec<u8> {
+        let mut bytes = vec![];
+        ciborium::ser::into_writer(&self, &mut bytes).unwrap()
+    }
+
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
         ciborium::de::from_reader(&*bytes).expect("deserialization must succeed.")
     }

examples/src/custom_types_example/src/lib.rs

@@ -1,8 +1,6 @@
 use candid::{CandidType, Decode, Deserialize, Encode};
 use ic_stable_structures::memory_manager::{MemoryId, MemoryManager, VirtualMemory};
-use ic_stable_structures::{
-    storable::Bound, DefaultMemoryImpl, StableBTreeMap, Storable,
-};
+use ic_stable_structures::{storable::Bound, DefaultMemoryImpl, StableBTreeMap, Storable};
 use std::{borrow::Cow, cell::RefCell};
 
 type Memory = VirtualMemory<DefaultMemoryImpl>;
@@ -30,6 +28,10 @@ impl Storable for UserProfile {
         Cow::Owned(Encode!(self).unwrap())
     }
 
+    fn into_bytes(self) -> Vec<u8> {
+        Encode!(&self).unwrap()
+    }
+
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
         Decode!(bytes.as_ref(), Self).unwrap()
     }

examples/src/vecs_and_strings/src/lib.rs

@@ -22,6 +22,10 @@ impl Storable for UserName {
         self.0.to_bytes()
     }
 
+    fn into_bytes(self) -> Vec<u8> {
+        self.0.into_bytes()
+    }
+
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
         Self(String::from_bytes(bytes))
     }
@@ -40,6 +44,10 @@ impl Storable for UserData {
         self.0.to_bytes()
     }
 
+    fn into_bytes(self) -> Vec<u8> {
+        self.0.into_bytes()
+    }
+
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
         Self(<Vec<u8>>::from_bytes(bytes))
     }

fuzz/fuzz_targets/data.rs

@@ -24,6 +24,10 @@ impl Storable for BoundedFuzzStruct {
         Cow::Owned(serde_cbor::ser::to_vec(self).unwrap())
     }
 
+    fn into_bytes(self) -> Vec<u8> {
+        serde_cbor::ser::to_vec(&self).unwrap()
+    }
+
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
         let value: Self = serde_cbor::de::from_slice(bytes.as_ref()).unwrap();
         value
@@ -41,6 +45,10 @@ impl Storable for UnboundedFuzzStruct {
         Cow::Owned(serde_cbor::ser::to_vec(self).unwrap())
     }
 
+    fn into_bytes(self) -> Vec<u8> {
+        serde_cbor::ser::to_vec(&self).unwrap()
+    }
+
     fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
         let value: Self = serde_cbor::de::from_slice(bytes.as_ref()).unwrap();
         value

src/btreemap.rs

@@ -178,6 +178,12 @@ const PAGE_SIZE_VALUE_MARKER: u32 = u32::MAX;
 ///         Cow::Owned(bytes)
 ///     }
 ///
+///     fn into_bytes(self) -> Vec<u8> {
+///         let mut bytes = Vec::new();
+///         // TODO: Convert your struct to bytes...
+///         bytes
+///     }
+///
 ///     fn from_bytes(bytes: Cow<[u8]>) -> Self {
 ///         // TODO: Convert bytes back to your struct
 ///         let (id, name) = (0, "".to_string());
@@ -492,7 +498,7 @@ where
     ///   key.to_bytes().len() <= max_size(Key)
     ///   value.to_bytes().len() <= max_size(Value)
     pub fn insert(&mut self, key: K, value: V) -> Option<V> {
-        let value = value.to_bytes_checked().into_owned();
+        let value = value.into_bytes_checked();
 
         let root = if self.root_addr == NULL {
             // No root present. Allocate one.
@@ -1428,7 +1434,7 @@ mod test {
 
     /// Encodes an object into a byte vector.
     fn encode<T: Storable>(object: T) -> Vec<u8> {
-        object.to_bytes_checked().into_owned()
+        object.into_bytes_checked()
     }
 
     /// A helper method to succinctly create a blob.
@@ -2980,6 +2986,10 @@ mod test {
             Cow::Borrowed(&[1, 2, 3, 4])
         }
 
+        fn into_bytes(self) -> Vec<u8> {
+            self.to_bytes().into_owned()
+        }
+
         fn from_bytes(_: Cow<[u8]>) -> Self {
             unimplemented!();
         }
@@ -3116,7 +3126,11 @@ mod test {
         struct T;
         impl Storable for T {
             fn to_bytes(&self) -> Cow<[u8]> {
-                Cow::Owned(vec![1, 2, 3])
+                Cow::Borrowed(&[1, 2, 3])
+            }
+
+            fn into_bytes(self) -> Vec<u8> {
+                self.to_bytes().into_owned()
             }
 
             fn from_bytes(bytes: Cow<[u8]>) -> Self {
@@ -3138,6 +3152,10 @@ mod test {
                 Cow::Owned(vec![1, 2, 3])
             }
 
+            fn into_bytes(self) -> Vec<u8> {
+                self.to_bytes().into_owned()
+            }
+
             fn from_bytes(bytes: Cow<[u8]>) -> Self {
                 assert_eq!(bytes.to_vec(), vec![1, 2, 3]);
                 T2

src/btreeset.rs

@@ -112,6 +112,10 @@ where
 ///         Cow::Owned(self.id.to_le_bytes().to_vec())
 ///     }
 ///
+///     fn into_bytes(self) -> Vec<u8> {
+///         self.id.to_le_bytes().to_vec()
+///     }
+///
 ///     fn from_bytes(bytes: Cow<[u8]>) -> Self {
 ///         let id = u64::from_le_bytes(bytes.as_ref().try_into().unwrap());
 ///         CustomType { id }