We're updating the issue view to help you get more done. 

Add swap-vals! and reset-vals! (swap! and reset! that return [old new])

Description

Sometimes, when swapping or resetting an atom, it's desirable to know the value before the update. The existing swap! and reset! functions return the new value instead. Currently, the only option is to roll your own using a loop and compare-and-set!

Example use cases:

  • When an atom contains a PersistentQueue and you want to atomically remove the head of the queue and process it: if you run (swap! q pop), you have lost the reference to the old head of the list so you can't process it.

  • Want to check if an operation has occurred before by using atom as a flag (this can be achieved with compare-and-set! but reads a little easier this way).

    1 2 3 4 (def has-run-once (atom false)) ... (when-not (get-and-set! has-run-once true) (do something))
  • Want to use an atom similarly to a java.util.concurrent.LinkedTransferQueue, for the case of pairing up adds by writers and drainTo y readers:

    1 2 3 4 Thread 1: (swap! atm conj item1) Thread 2: (swap! atm conj item2) Thread 3: (let [new-vals (get-and-set! atm [])] (do-something new-vals))

Approach: Add clojure.core/swap-vals! and clojure.core/reset-vals! that return [old new]

Patch: clj-1454-4.patch

Environment

None

Status

Assignee

Unassigned

Reporter

Philip Potter

Labels

Approval

Ok

Patch

Code and Test

Fix versions

Priority

Critical