Skip to content

Commit f0c2f87

Browse files
committed
fix(adapters): standardize make/cleanup naming; reflect T in moodycamel name
Per Gemini review on PR #23. 1. nim_channel_adapter: rename initNimChannelAdapter → makeNimChannelAdapter and deinitNimChannelAdapter → cleanup, matching the makeLoonyAdapter / makeBoostLockfreeQueueAdapter / makeMoodycamelAdapter / makeCrossbeamArrayQueueAdapter convention. 2. threading_channels_adapter: same rename — initThreadingChannelsAdapter → makeThreadingChannelsAdapter, deinitThreadingChannelsAdapter → cleanup. Update the docstring's example accordingly. 3. moodycamel_adapter.name: drop the hardcoded `uint64` literal in the returned string and use $T. The C++ wrapper is uint64-specialized today, but the adapter is generic; keeping the name in sync with T matches every other adapter's name proc. 4. Update three call-site groups: bench_mpmc.nim's initThreadingChannelsQ wrapper, bench_mpsc.nim's initNimChannelQ wrapper, smoke_threading_channels.nim, and t_bench_adapters.nim suite blocks. Compile-checked bench_mpsc and bench_mpmc locally.
1 parent b162ee6 commit f0c2f87

7 files changed

Lines changed: 15 additions & 16 deletions

File tree

benchmarks/nim/adapters/moodycamel_adapter.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ when defined(adapter_moodycamel_available):
8686
PopResult[T](success: false)
8787

8888
proc name*[T](a: MoodycamelAdapter[T]): string =
89-
"moodycamel/ConcurrentQueue[uint64]"
89+
"moodycamel/ConcurrentQueue[" & $T & "]"

benchmarks/nim/adapters/nim_channel_adapter.nim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ when defined(adapter_nim_channel_available):
5353
## stdlib's pre-ARC channel implementation does not
5454
## support cleanly).
5555

56-
proc initNimChannelAdapter*[T](capacity: int = 1024
56+
proc makeNimChannelAdapter*[T](capacity: int = 1024
5757
): NimChannelAdapter[T] =
5858
## ``capacity`` is the maximum number of in-flight messages.
5959
## ``capacity <= 0`` selects an unlimited channel (matches
@@ -62,7 +62,7 @@ when defined(adapter_nim_channel_available):
6262
result.chan = create(Channel[T])
6363
result.chan[].open(if capacity < 0: 0 else: capacity)
6464

65-
proc deinitNimChannelAdapter*[T](a: var NimChannelAdapter[T]) =
65+
proc cleanup*[T](a: var NimChannelAdapter[T]) =
6666
if a.chan != nil:
6767
a.chan[].close()
6868
dealloc(a.chan)

benchmarks/nim/adapters/threading_channels_adapter.nim

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ when defined(adapter_threading_channels_available):
4545
## module reclaims the underlying buffer; we never call it
4646
## directly.
4747

48-
proc initThreadingChannelsAdapter*[T](capacity: int = 1024
48+
proc makeThreadingChannelsAdapter*[T](capacity: int = 1024
4949
): ThreadingChannelsAdapter[T] =
5050
## ``capacity`` maps to ``newChan[T]``'s ``elements`` argument.
5151
## Defaulted to 1024 for parity with other bounded MPMC adapters.
@@ -54,12 +54,11 @@ when defined(adapter_threading_channels_available):
5454
let cap = if capacity <= 0: 1 else: capacity
5555
result.chan = newChan[T](elements = cap)
5656

57-
proc deinitThreadingChannelsAdapter*[T](
58-
a: var ThreadingChannelsAdapter[T]) =
57+
proc cleanup*[T](a: var ThreadingChannelsAdapter[T]) =
5958
## Explicit teardown is a no-op: ``Chan[T]`` cleans itself up
6059
## via its move/destroy hooks. The proc exists so callers can
61-
## use ``defer: deinitThreadingChannelsAdapter(a)`` for parity
62-
## with other adapters' ``cleanup`` shapes.
60+
## use ``defer: cleanup(a)`` for parity with other adapters'
61+
## ``cleanup`` shapes.
6362
discard a
6463

6564
proc push*[T](a: var ThreadingChannelsAdapter[T], item: T): PushResult =

benchmarks/nim/bench_mpmc.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ when defined(adapter_crossbeam_array_queue_available):
296296

297297
when defined(adapter_threading_channels_available):
298298
proc initThreadingChannelsQ(capacity: int): ThreadingChannelsAdapter[uint64] =
299-
initThreadingChannelsAdapter[uint64](capacity)
299+
makeThreadingChannelsAdapter[uint64](capacity)
300300

301301
proc runMvpMpmcShape[A](
302302
em: var BMFEmitter,

benchmarks/nim/bench_mpsc.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ proc runMupsicShape[N, P: static int; T](
155155

156156
when defined(adapter_nim_channel_available):
157157
proc initNimChannelQ(capacity: int): NimChannelAdapter[uint64] =
158-
initNimChannelAdapter[uint64](capacity)
158+
makeNimChannelAdapter[uint64](capacity)
159159

160160
proc runNimChannelShape(
161161
em: var BMFEmitter,

benchmarks/nim/smoke/smoke_threading_channels.nim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ proc main() =
2323
echo "threading_channels smoke: starting"
2424

2525
block:
26-
var a = initThreadingChannelsAdapter[uint64](capacity = 64)
27-
defer: deinitThreadingChannelsAdapter(a)
26+
var a = makeThreadingChannelsAdapter[uint64](capacity = 64)
27+
defer: cleanup(a)
2828
for i in 0'u64 ..< 32'u64:
2929
let r = a.push(i)
3030
doAssert r == prSuccess, "threading_channels push failed at i=" & $i

tests/t_bench_adapters.nim

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ when defined(adapter_threading_channels_available):
123123
suite "threading_channels_adapter":
124124
test "push/pop 1000 uint64 round-trip preserves set":
125125
runRoundTrip[ThreadingChannelsAdapter[uint64]](
126-
initThreadingChannelsAdapter[uint64](capacity = 4096),
127-
deinitThreadingChannelsAdapter(adapter)
126+
makeThreadingChannelsAdapter[uint64](capacity = 4096),
127+
cleanup(adapter)
128128
)
129129

130130
when defined(adapter_nim_channel_available):
@@ -134,6 +134,6 @@ when defined(adapter_nim_channel_available):
134134
suite "nim_channel_adapter":
135135
test "push/pop 1000 uint64 round-trip preserves set":
136136
runRoundTrip[NimChannelAdapter[uint64]](
137-
initNimChannelAdapter[uint64](capacity = 4096),
138-
deinitNimChannelAdapter(adapter)
137+
makeNimChannelAdapter[uint64](capacity = 4096),
138+
cleanup(adapter)
139139
)

0 commit comments

Comments
 (0)