0.5.0; api simplification and boilerplate cleanup

README.md

@@ -92,7 +92,7 @@ if lock.wAcquire():
 let lock = initWRFLock()
 
 if lock.wAcquire():
-  while not lock.wTimeWait(1_000):
+  while not lock.wWait(1_000):
     # Do other things if the lock times out waiting for its action
   # Do write things here
   lock.wRelease()
@@ -102,6 +102,22 @@ if lock.wAcquire():
 > locks. Yield TimeWaits will always complete after the allotted time. Blocking TimeWaits can actually wait longer than the allotted time. It is guaranteed to
 > either eventually succeed or time out.
 
+---
+
+### Alternative API
+
+```nim
+let lock = initWRFLock()
+
+if lock.acquire(Write):
+  while not lock.wait(Write, 1_000):
+    # Do other things if the lock times out waiting for its action
+  # Do write things here
+  lock.release(Write)
+```
+
+---
+
 By default, the Wait operations for all 3 actions (write, read, free) are blocking
 using a futex. You can pass flags to change this to just have the thread yield
 to the scheduler for any of the actions.

tests/test.nim

@@ -26,13 +26,13 @@ var counter {.global.}: Atomic[int]
 proc writeLock() {.thread.} =
   sleep(1000)
   doassert lock.wAcquire()
-  lock.wWait()
+  discard lock.wWait()
   discard counter.fetchAdd(1)
   doassert lock.wRelease()
 
 proc readLock() {.thread.} =
   sleep(200)
-  lock.withRLock:
+  lock.withLock(Read):
     try:
       check counter.load == 1
     except Exception:
@@ -44,7 +44,7 @@ proc readLock() {.thread.} =
 proc freeLock() {.thread.} =
   sleep(500)
   doassert lock.fAcquire()
-  if not lock.fTimeWait(1_000):
+  if not lock.fWait(1_000):
     return
   counter.store(-10000)
   doassert lock.fRelease()