Changeset 27259 in project

Timestamp:

08/18/12 14:48:02 (9 years ago)

Author:

Moritz Heidkamp

Message:

clojurian: Document version 0.0.2

File:

• wiki/eggref/4/clojurian (modified) (3 diffs)

wiki/eggref/4/clojurian

@@ -8 +8 @@
 === Overview
 
-Currently the only module provided by this egg is {{clojurian-syntax}}.
+Currently this egg provides two modules: {{clojurian-syntax}} and
+{{clojurian-atom}}.
 
 === Modules
@@ -94 +95 @@
 
 
+<syntax>(if-let (var val) then else)</syntax>
+
+Equivalent to {{(let ((var val)) (if var then else))}}.
+
+
+<syntax>(if-let* ((x1 y1) (x2 y2) ...) then else)</syntax>
+
+Equivalent to {{(or (and-let* ((x1 y1) (x2 y2) ...) then) else)}}.
+
+
+==== clojurian-atom (experimental)
+
+This module provides an implementation of
+[[http://clojure.org/atoms|Clojure's atom reference type]]. It is in
+an experimental state right now and only provides the very basic
+functionality, e.g. validators and watches are still missing. Note
+that atoms only work with immutable data structures so they can't be
+used to coordinate updates of record slots, for example.
+
+
+<procedure>(atom value)</procedure>
+
+Returns and atom with the given initial {{value}}.
+
+
+<procedure>(atom? x)</procedure>
+
+Checks whether {{x}} is an atom.
+
+
+<procedure>(atom-value atom)</procedure>
+
+Returns the current value of {{atom}}.
+
+
+<procedure>(compare-and-set! atom old new)</procedure>
+
+Atomically sets the value of {{atom}} to {{new}} if its current value
+is {{eq?}} to the given {{old}} value. Returns {{#t}} if the update
+was successful and {{#f}} if not.
+
+
+<procedure>(swap! atom proc . args)</procedure>
+
+Atomically swaps the value of {{atom}} to be {{(apply proc (atom-value
+atom) args)}}. Because {{proc}} may be called multiple times it must
+be free of side-effects. Returns the new value of {{atom}}.
+
+
+<procedure>(reset! atom value)</procedure>
+
+Sets the value of {{atom}} to {{value}}. Returns {{value}}.
+
+
 === About this egg
 
@@ -110 +165 @@
 ==== Version history
 
+; 0.0.2 : Add {{if-let}}, {{if-let*}} and {{clojurian-atom}}
 ; 0.0.1 : Initial release