about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDaniel Micay <danielmicay@gmail.com>2014-10-28 18:46:27 -0400
committerDaniel Micay <danielmicay@gmail.com>2014-10-28 19:00:16 -0400
commit8a719255589bcbc82c961e051f09678b524f4149 (patch)
treee23dc6f6ca579f59078030d42e6568f482516c1f
parent768a7e1a4a891191f3653cebc223dfad0e8b875c (diff)
reference: document unwinding unsafety issues
-rw-r--r--src/doc/reference.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md
index cfa69cdfd49..7f410b7fd93 100644
--- a/src/doc/reference.md
+++ b/src/doc/reference.md
@@ -1170,6 +1170,9 @@ exposing an API making it possible for it to occur in safe code.
   * A discriminant in an `enum` not included in the type definition
   * A value in a `char` which is a surrogate or above `char::MAX`
   * non-UTF-8 byte sequences in a `str`
+* Unwinding into Rust from foreign code or unwinding from Rust into foreign
+  code. Rust's failure system is not compatible with exception handling in
+  other languages. Unwinding must be caught and handled at FFI boundaries.
 
 ##### Behaviour not considered unsafe