michael/mlua
michael
/
mlua
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README

This commit is contained in:
kyren 2017-05-22 16:40:43 -04:00
parent 5c0f183a52
commit 7dc7d8edbe
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -60,7 +60,7 @@ in rustc. For example:
callback. Until then, it is impossible to name the type of the function callback. Until then, it is impossible to name the type of the function
that would do the wrapping. that would do the wrapping.
* Once tuple based variadic generics land, the plan is to completely * Once tuple based variadic generics land, the plan is to completely
eliminate the lua multi macros in favor of simple tuples. eliminate the hlist macros in favor of simple tuples.
See [this reddit discussion](http://www.reddit.com/r/rust/comments/5yujt6/) for See [this reddit discussion](http://www.reddit.com/r/rust/comments/5yujt6/) for
details of the current lifetime problem with callback wrapping. details of the current lifetime problem with callback wrapping.
@ -80,6 +80,8 @@ of the crate "Work In Progress". The GOAL is for the crate to handle tricky
situations such as: situations such as:
* Panic safety, and carrying the panic across the lua api correctly * Panic safety, and carrying the panic across the lua api correctly
* Passing rust panics across the lua boundary as lua errors without allowing
lua to catch rust panics as normal errors.
* Lua stack size checking, and correctly handling lua being out of stack * Lua stack size checking, and correctly handling lua being out of stack
space space
* Leaving the correct elements on the lua stack and in the correct order, * Leaving the correct elements on the lua stack and in the correct order,
@ -87,7 +89,7 @@ situations such as:
* Correctly guarding the metatables of userdata so that scripts cannot, for * Correctly guarding the metatables of userdata so that scripts cannot, for
example, swap the `__gc` methods around and cause UB. example, swap the `__gc` methods around and cause UB.
The library currently attempts to handle each of these situations, but there The library currently *attempts* to handle each of these situations, but there
are so many ways to cause unsafety with Lua that it just needs more testing. are so many ways to cause unsafety with Lua that it just needs more testing.
## Examples ## Examples