summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLinus Färnstrand <faern@faern.net>2018-07-30 16:57:55 +0200
committerLinus Färnstrand <faern@faern.net>2018-07-30 16:57:55 +0200
commite167a73564f513e68d6c35dfa940bc7baefb9554 (patch)
tree418cda7a24e650c766c0459580ad1f2583ac95a3 /README.md
parent28196346966968741d6864557be5a2aa0ede2edb (diff)
downloadrust-libc-e167a73564f513e68d6c35dfa940bc7baefb9554.tar.gz
Describe the align feature in the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5c25923281..a19a56ee0f 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,16 @@ this via:
libc = { version = "0.2", default-features = false }
```
+By default libc uses private fields in structs in order to enforce a certain
+memory alignment on them. These structs can be hard to instantiate outside of
+libc. To make libc use `#[repr(align(x))]`, instead of the private fields,
+activate the *align* feature. This requires Rust 1.25 or newer:
+
+```toml
+[dependencies]
+libc = { version = "0.2", features = ["align"] }
+```
+
## What is libc?
The primary purpose of this crate is to provide all of the definitions necessary