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

Update docs to include warning about RegistryKey in callbacks

This commit is contained in:
kyren 2018-03-06 06:23:04 -05:00
parent eb154e4a9e
commit 1e76de1d08
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/types.rs
View File

@ -24,10 +24,11 @@ pub struct LightUserData(pub *mut c_void);
/// difficult to use than the normal handle types, it is Send + Sync + 'static, which means that it /// difficult to use than the normal handle types, it is Send + Sync + 'static, which means that it
/// can be used in many situations where it would be impossible to store a regular handle value. /// can be used in many situations where it would be impossible to store a regular handle value.
/// ///
/// Be warned, If you place this into Lua via a `UserData` type, it is *very easy* to accidentally /// Be warned, If you place this into Lua via a `UserData` type or a rust callback, it is *very
/// cause reference cycles that the Lua garbage collector cannot resolve. Instead of placing a /// easy* to accidentally cause reference cycles that the Lua garbage collector cannot resolve.
/// `RegistryKey` into a `UserData` type, prefer instead to use `UserData::set_user_value` / /// Instead of placing a `RegistryKey` into a `UserData` type, prefer instead to use
/// `UserData::get_user_value`. /// `UserData::set_user_value` / `UserData::get_user_value`, and instead of moving a RegistryKey
/// into a callback, prefer `Lua::scope`.
pub struct RegistryKey { pub struct RegistryKey {
pub(crate) registry_id: c_int, pub(crate) registry_id: c_int,
pub(crate) unref_list: Arc<Mutex<Option<Vec<c_int>>>>, pub(crate) unref_list: Arc<Mutex<Option<Vec<c_int>>>>,