mirror of
https://github.com/roc-lang/roc.git
synced 2025-09-26 21:39:07 +00:00
27 lines
772 B
Text
27 lines
772 B
Text
interface Box
|
|
exposes [box, unbox]
|
|
imports []
|
|
|
|
## Allocates a value on the heap. Boxing is an expensive process as it copies
|
|
## the value from the stack to the heap. This may provide a performance
|
|
## optimization for advanced use cases with large values. A platform may require
|
|
## that some values are boxed.
|
|
## ```
|
|
## expect Box.unbox (Box.box "Stack Faster") == "Stack Faster"
|
|
## ```
|
|
box : a -> Box a
|
|
|
|
## Returns a boxed value.
|
|
## ```
|
|
## expect Box.unbox (Box.box "Stack Faster") == "Stack Faster"
|
|
## ```
|
|
unbox : Box a -> a
|
|
|
|
# # we'd need reset/reuse for box for this to be efficient
|
|
# # that is currently not implemented
|
|
# map : Box a, (a -> b) -> Box b
|
|
# map = \boxed, transform =
|
|
# boxed
|
|
# |> Box.unbox
|
|
# |> transform
|
|
# |> Box.box
|