Async cancellation safety

Update TODO comments.
moka-rs · Aug 23, 2023 · 54ab77b · 54ab77b
1 parent 6b045b6
commit 54ab77b
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/MIGRATION-GUIDE.md b/MIGRATION-GUIDE.md
@@ -242,7 +242,6 @@ free some memory), you do not need to call `run_pending_tasks` method.
    - To enable it, see [Enabling the thread pool](#enabling-the-thread-pool) for more
      details.
 
-
 #### Enabling the thread pool
 
 To enable the thread pool, do the followings:

diff --git a/src/future/base_cache.rs b/src/future/base_cache.rs
@@ -547,8 +547,9 @@ where
                 }
 
                 if self.is_removal_notifier_enabled() {
-                    // TODO: Make this one resumable. (Pass `kl`, `_klg`, `upd_op`
-                    // and `ts`)
+                    // TODO: Async cancellation safety: Make this resumable.
+                    // (NOTE: Move `kl`, `_klg`, `upd_op` and `ts` into the
+                    // Future)
                     self.inner
                         .notify_upsert(key, &old_entry, old_last_accessed, old_last_modified)
                         .await;
@@ -589,8 +590,9 @@ where
                     }
 
                     if self.is_removal_notifier_enabled() {
-                        // TODO: Make this one resumable. (Pass `kl`, `_klg`, `upd_op`
-                        // and `ts`)
+                        // TODO: Async cancellation safety: Make this resumable.
+                        // (NOTE: Move `kl`, `_klg`, `upd_op` and `ts` into the
+                        // Future)
                         self.inner
                             .notify_upsert(key, &old_entry, old_last_accessed, old_last_modified)
                             .await;

diff --git a/src/future/cache.rs b/src/future/cache.rs
@@ -1432,9 +1432,9 @@ where
 
                 let op = WriteOp::Remove(kv);
                 let hk = self.base.housekeeper.as_ref();
-                // TODO: If enclosing future is being dropped, save `op` and `now` so
-                // that we can resume later. (maybe we can send to an unbound mpsc
-                // channel)
+                // TODO: Async cancellation safety: If enclosing future is being
+                // dropped, save `op` and `now` so that we can resume later. (maybe
+                // we can send to an unbound mpsc channel)
                 Self::schedule_write_op(&self.base.inner, &self.base.write_op_ch, op, now, hk)
                     .await
                     .expect("Failed to remove");
@@ -1881,8 +1881,9 @@ where
 
         let (op, now) = self.base.do_insert_with_hash(key, hash, value).await;
         let hk = self.base.housekeeper.as_ref();
-        // TODO: If enclosing future is being dropped, save `op` and `now` so that
-        // we can resume later. (maybe we can send to an unbound mpsc channel)
+        // TODO: Async cancellation safety: If enclosing future is being dropped,
+        // save `op` and `now` so that we can resume later. (maybe we can send to an
+        // unbound mpsc channel)
         Self::schedule_write_op(&self.base.inner, &self.base.write_op_ch, op, now, hk)
             .await
             .expect("Failed to insert");