Merge pull request #240 from amethyst/release_prep_20220126

Release prep 20220126.

Author: jugglerchris

CHANGELOG.md

@@ -1,3 +1,27 @@
+## [0.19.0]
+- The Lua C library build now uses separate -sys crates, and bindgen rather than
+  hand-maintained declarations.  (Thanks @pollend!)  The "builtin-lua51" feature
+  is now available.
+- Value::Integer is now no longer available when building for Lua 5.1.  (In Lua 5.1
+  there is no integer type).
+- Add `Function::dump()` which produces the compiled version of a function (like
+  the `string.dump` Lua function or `lua_dump()` C API).
+- Add unsafe `Chunk::into_function_allow_binary()`.  This allows loading a compiled
+  binary generated from `Function::dump()`.
+- Add `Initflags` to control some settings done when `Lua` is initialised.  They
+  can be specified with the new unsafe `Lua::unsafe_new_with_flags()` constructor.
+  The flags available (all set by default with the other constructors):
+  * PCALL_WRAPPERS:
+    - wrap pcall and xpcall so that they don't allow catching Rust panics
+  * LOAD_WRAPPERS:
+    - wrap functions load, loadfile, dofile (and loadstring for lua 5.1) to prevent
+      loading compiled/bytecode modules.
+  * REMOVE_LOADLIB:
+    - Remove `package.loadlib` and the module finding functions which allow loading
+      compiled C libraries.
+- `String<'lua>` now implements `Eq` and `Hash` (can be useful for local collections
+  within a context callback).
+
 ## [0.18.0]
 - Add support for multiple Lua versions, including 5.1, 5.3 and 5.4 (the default)
 - Add implementations of `FromLua` and `ToLua` for `[T;N]`.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rlua"
-version = "0.18.1-pre0"
+version = "0.19.0"
 authors = ["kyren <[email protected]>"]
 edition = "2018"
 description = "High level bindings to Lua 5.x"
@@ -32,9 +32,9 @@ libc = { version = "0.2" }
 num-traits = { version = "0.2.14" }
 bitflags = { version = "1.0.4" }
 bstr = {version = "0.2", features = ["std"], default_features = false }
-rlua-lua54-sys = { path = "./crates/rlua-lua54-sys", optional = true }
-rlua-lua53-sys = { path = "./crates/rlua-lua53-sys", optional = true }
-rlua-lua51-sys = { path = "./crates/rlua-lua51-sys", optional = true }
+rlua-lua54-sys = { version = "0.1.0", optional = true }
+rlua-lua53-sys = { version = "0.1.0", optional = true }
+rlua-lua51-sys = { version = "0.1.0", optional = true }
 
 
 [dev-dependencies]

README.md

@@ -24,7 +24,9 @@ something you feel could perform better, feel free to file a bug report.
 Currently, this library follows a pre-1.0 semver, so all API changes should be
 accompanied by 0.x version bumps.  See the [Version 1.0
 milestone](https://github.com/amethyst/rlua/milestone/1) for the work planned
-to be done before a more stable 1.0 release.
+to be done before a more stable 1.0 release.  There may be breaking changes as
+these issues are dealt with on the way (the version number will be bumped as
+needed).
 
 ## Lua versions supported
 
@@ -41,27 +43,29 @@ The available features are:
 
 | Cargo feature | Lua version |
 | ------------- | ----------- |
-| builtin-lua54 | Lua 5.4 (source included in crate, default) |
-| builtin-lua53 | Lua 5.3 (source included in crate) |
-| system-lua51 | Lua 5.1 (installed on host system, found using pkg-config) |
-| system-lua53 | Lua 5.3 (installed on host system, found using pkg-config) |
+| builtin-lua54 | Lua 5.4 (source included in package, default) |
+| builtin-lua53 | Lua 5.3 (source included in package) |
+| builtin-lua51 | Lua 5.1 (source included in package) |
 | system-lua54 | Lua 5.4 (installed on host system, found using pkg-config) |
+| system-lua53 | Lua 5.3 (installed on host system, found using pkg-config) |
+| system-lua51 | Lua 5.1 (installed on host system, found using pkg-config) |
 
 At current writing rlua has not been tested with alternative Lua
 implementations (such as Luajit) which share PUC-Rio Lua's C API, but it is
-expected that they can be made to work with little if any change to rlua.
+expected that they can be made to work with little if any change to rlua, and
+support would be welcome.
 
 ## Safety and Panics
 
-The goal of this library is complete safety: it should not be possible to cause
-undefined behavior with the safe API, even in edge cases.  Unsoundness is
-considered the most serious kind of bug, so if you find the ability to cause UB
-with this API without `unsafe`, please file a bug report.
+The goal of this library is complete safety by default: it should not be
+possible to cause undefined behavior with the safe API, even in edge cases.
+Unsoundness is considered the most serious kind of bug, so if you find the
+ability to cause UB with this API without `unsafe`, please file a bug report.
 
-*NOTE: There are some Lua stdlib functions which are currently not wrapped or
-behind an unsafe boundary and can be used by scripts to cause memory unsafety,
-please see [this issue](https://github.com/kyren/rlua/issues/116) for more
-details.*
+This includes calling functions in the Lua standard library; some unsafe
+functions are wrapped by default (for example to prevent loading binary
+modules), but these wrappers can be disabled using one of the `unsafe`
+constructors for the `Lua` object if required for the application.
 
 Another goal of this library is complete protection from panics: currently, it
 should not be possible for a script to trigger a panic.  There ARE however

RELEASE.md

@@ -8,6 +8,7 @@
 * Check other fields in Cargo.toml are sensible
 * Check that CI is passing
 * Tag the commit for the release
+* Run `cargo publish` on -sys crates if updated.
 * Run `cargo publish`
 * Check that the version from crates.io looks good
 * Update version number on branch to (next version)-alpha.