diff options
| author | Audun Wilhelmsen <skyfex@gmail.com> | 2014-03-20 23:11:33 +0100 |
|---|---|---|
| committer | Audun Wilhelmsen <skyfex@gmail.com> | 2014-03-20 23:11:33 +0100 |
| commit | b59fba584521a0a9d4fe97ee4a5d608ec19aedc4 (patch) | |
| tree | eb87c87950d6d64af601cc33fd55b8f0b17969fe /doc/manual.txt | |
| parent | 09bda74e7d3cbc5e606be6c4b6c68230013948e3 (diff) | |
| download | Nim-b59fba584521a0a9d4fe97ee4a5d608ec19aedc4.tar.gz | |
Added documentation for packed pragma
Diffstat (limited to 'doc/manual.txt')
| -rw-r--r-- | doc/manual.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/manual.txt b/doc/manual.txt index ab1badaf3..9497e957d 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -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 ---------------- |