suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs for _box C type

Browse Source
This commit is contained in:
Asumu Takikawa 2016-06-07 14:37:12 -04:00
parent 416c9ecec0
commit f0003da766
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pkgs/racket-doc/scribblings/foreign/types.scrbl
View File

@ -991,12 +991,21 @@ integer pointer, and use the value that is placed there as a second
return value.} return value.}
@defidform[_box]{ @defform[(_box type)]{
A @tech{custom function type} similar to a @racket[(_ptr io _type)] A @tech{custom function type} similar to a @racket[(_ptr io _type)]
argument, where the input is expected to be a box holding an argument, where the input is expected to be a box holding an
appropriate value, which is unboxed on entry and modified accordingly appropriate value, which is unboxed on entry and modified accordingly
on exit.} on exit.
Example:
@racketblock[
(_fun (_box _int) -> _void)
(_fun [boxed : (_box _int) = (box 0)]
-> [res : _int]
-> (values res (unbox boxed)))
]}
@defform/subs[(_list mode type maybe-len) @defform/subs[(_list mode type maybe-len)
([mode i o io] ([mode i o io]