cbaines/guile-knots
1
Fork 0
Code Issues 1 Pull requests Activity Actions

Add documentation for lots of the "undocumented" bits
All checks were successful
/ test (push) Successful in 6s
Details

Browse source 
In the Guile Documenta generated documentation.
This commit is contained in:
Christopher Baines 2026-03-23 11:56:53 +00:00
parent d282841a78
commit d0ff89023b
8 changed files with 140 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

36
knots/resource-pool.scm
View file

@ -86,6 +86,22 @@
set-resource-pool-channel!)
(destroy-condition resource-pool-destroy-condition)
(configuration resource-pool-configuration))
(set-procedure-property!
(macro-transformer (module-ref (current-module) 'resource-pool?))
'documentation
"Return @code{#t} if OBJ is a @code{<resource-pool>}.")
(set-procedure-property!
(macro-transformer (module-ref (current-module) 'resource-pool-name))
'documentation
"Return the name of the resource pool.")
(set-procedure-property!
(macro-transformer (module-ref (current-module) 'resource-pool-channel))
'documentation
"Return the channel used by the resource pool.")
(set-procedure-property!
(macro-transformer (module-ref (current-module) 'resource-pool-configuration))
'documentation
"Return the configuration alist of the resource pool.")
(set-record-type-printer!
<resource-pool>
@ -1277,12 +1293,16 @@ receive @code{&resource-pool-destroyed}."
(exception-accessor
&resource-pool-timeout
(record-accessor &resource-pool-timeout 'pool)))
(set-procedure-property! resource-pool-timeout-error-pool 'documentation
"Return the pool from a @code{&resource-pool-timeout} exception.")
(define make-resource-pool-timeout-error
(record-constructor &resource-pool-timeout))
(define resource-pool-timeout-error?
(exception-predicate &resource-pool-timeout))
(set-procedure-property! resource-pool-timeout-error? 'documentation
"Return @code{#t} if OBJ is a @code{&resource-pool-timeout} exception.")
(define &resource-pool-too-many-waiters
(make-exception-type '&recource-pool-too-many-waiters
@ -1293,17 +1313,23 @@ receive @code{&resource-pool-destroyed}."
(exception-accessor
&resource-pool-too-many-waiters
(record-accessor &resource-pool-too-many-waiters 'pool)))
(set-procedure-property! resource-pool-too-many-waiters-error-pool 'documentation
"Return the pool from a @code{&resource-pool-too-many-waiters} exception.")
(define resource-pool-too-many-waiters-error-waiters-count
(exception-accessor
&resource-pool-too-many-waiters
(record-accessor &resource-pool-too-many-waiters 'waiters-count)))
(set-procedure-property! resource-pool-too-many-waiters-error-waiters-count 'documentation
"Return the waiters count from a @code{&resource-pool-too-many-waiters} exception.")
(define make-resource-pool-too-many-waiters-error
(record-constructor &resource-pool-too-many-waiters))
(define resource-pool-too-many-waiters-error?
(exception-predicate &resource-pool-too-many-waiters))
(set-procedure-property! resource-pool-too-many-waiters-error? 'documentation
"Return @code{#t} if OBJ is a @code{&resource-pool-too-many-waiters} exception.")
(define &resource-pool-destroyed
(make-exception-type '&recource-pool-destroyed
@ -1314,12 +1340,16 @@ receive @code{&resource-pool-destroyed}."
(exception-accessor
&resource-pool-destroyed
(record-accessor &resource-pool-destroyed 'pool)))
(set-procedure-property! resource-pool-destroyed-error-pool 'documentation
"Return the pool from a @code{&resource-pool-destroyed} exception.")
(define make-resource-pool-destroyed-error
(record-constructor &resource-pool-destroyed))
(define resource-pool-destroyed-error?
(exception-predicate &resource-pool-destroyed))
(set-procedure-property! resource-pool-destroyed-error? 'documentation
"Return @code{#t} if OBJ is a @code{&resource-pool-destroyed} exception.")
(define &resource-pool-destroy-resource
(make-exception-type '&recource-pool-destroy-resource
@ -1328,9 +1358,13 @@ receive @code{&resource-pool-destroyed}."
(define make-resource-pool-destroy-resource-exception
(record-constructor &resource-pool-destroy-resource))
(set-procedure-property! make-resource-pool-destroy-resource-exception 'documentation
"Construct a @code{&resource-pool-destroy-resource} exception.")
(define resource-pool-destroy-resource-exception?
(exception-predicate &resource-pool-destroy-resource))
(set-procedure-property! resource-pool-destroy-resource-exception? 'documentation
"Return @code{#t} if OBJ is a @code{&resource-pool-destroy-resource} exception.")
(define resource-pool-default-timeout-handler
(make-parameter #f))
@ -1467,6 +1501,8 @@ available. Return the resource once PROC has returned."
(apply values vals)))))))
(define-syntax-rule (with-resource-from-pool pool resource exp ...)
"Evaluate EXP ... with RESOURCE bound to a resource checked out from
POOL. Syntactic sugar around @code{call-with-resource-from-pool}."
(call-with-resource-from-pool
pool
(lambda (resource) exp ...)))