|  | 
| 1 |  | -# Standard library bindings for mlua | 
|  | 1 | +# mlua-stdlib | 
| 2 | 2 | 
 | 
| 3 |  | -Reserved for future work | 
|  | 3 | +[](https://crates.io/crates/mlua-stdlib) | 
|  | 4 | +[](https://docs.rs/mlua-stdlib) | 
|  | 5 | +[](https://codecov.io/gh/mlua-rs/mlua-stdlib) | 
|  | 6 | + | 
|  | 7 | +A standard library for [mlua](https://github.com/mlua-rs/mlua), providing common functionality and utilities for Lua scripting in Rust applications. | 
|  | 8 | + | 
|  | 9 | +## Features | 
|  | 10 | + | 
|  | 11 | +mlua-stdlib provides a collection of modules that extend Lua with useful functionality: | 
|  | 12 | + | 
|  | 13 | +- **assertions** - Useful assertion functions for testing and validation | 
|  | 14 | +- **testing** - A testing framework with hooks and reporting | 
|  | 15 | +- **env** - Environment functions | 
|  | 16 | + | 
|  | 17 | +With the following optional modules: | 
|  | 18 | +- **json** (feature) - JSON encoding/decoding | 
|  | 19 | +- **regex** (feature) - Regular expressions support | 
|  | 20 | +- **yaml** (feature) - YAML encoding/decoding | 
|  | 21 | + | 
|  | 22 | +The following feature flags are passed to `mlua`, when enabled: | 
|  | 23 | + | 
|  | 24 | +- `lua51`, `lua52`, `lua53`, `lua54`, `luau` - Lua version selection | 
|  | 25 | +- `send` - Enable `Send+Sync` support | 
|  | 26 | +- `vendored` - Use vendored Lua | 
|  | 27 | + | 
|  | 28 | +## Documentation | 
|  | 29 | + | 
|  | 30 | +The project is still in early stages, the API documentation will be published on [docs.rs](https://docs.rs/mlua-stdlib) or in the repository once stabilized. | 
|  | 31 | + | 
|  | 32 | +## Examples | 
|  | 33 | + | 
|  | 34 | +Check the `tests/lua/` directory for comprehensive examples of how to use each module. | 
|  | 35 | + | 
|  | 36 | +## License | 
|  | 37 | + | 
|  | 38 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | 
0 commit comments