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

Added documentation for packed pragma

Browse source
This commit is contained in:
Audun Wilhelmsen 2014-03-20 23:11:33 +01:00
commit b59fba5845
2 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/manual.txt
View file

@ -5390,6 +5390,11 @@ checked.
**Future directions**: GC'ed memory should be allowed in unions and the GC
should scan unions conservatively.
Packed pragma
-------------
The `packed`:idx: pragma can be applied to any ``object`` type. It ensures that the fields of an object is packed back-to-back in memory. It is useful to store packets or messages from/to network or hardware drivers, and for interoperability with C. Combining packed pragma with inheritance is not defined, and it should not be used with GC'ed memory (ref's).
**Future directions**: Using GC'ed memory in packed pragma will result in compile-time error. Usage with inheretinence should be defined and documented.
Unchecked pragma
----------------