jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added few documentation lines for the unsafeAddr operator. (#5362)

Browse source
This commit is contained in:
Arne Döring 2017-03-23 23:49:07 +01:00 • committed by Andreas Rumpf
commit d4b4cad4ea
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/system.nim
View file

@ -154,9 +154,13 @@ proc `addr`*[T](x: var T): ptr T {.magic: "Addr", noSideEffect.} =
discard discard
proc unsafeAddr*[T](x: T): ptr T {.magic: "Addr", noSideEffect.} = proc unsafeAddr*[T](x: T): ptr T {.magic: "Addr", noSideEffect.} =
## Builtin 'addr' operator for taking the address of a memory location. ## Builtin 'addr' operator for taking the address of a memory
## This works even for ``let`` variables or parameters for better interop ## location. This works even for ``let`` variables or parameters
## with C and so it is considered even more unsafe than the ordinary ``addr``. ## for better interop with C and so it is considered even more
## unsafe than the ordinary ``addr``. When you use it to write a
## wrapper for a C library, you should always check that the
## original library does never write to data behind the pointer that
## is returned from this procedure.
## Cannot be overloaded. ## Cannot be overloaded.
discard discard