luaserialization

• Index

Contents

• Features
• Installation
• License

Topics

• README
• CHANGE_LOG
• LICENSE

Modules

• data
• string
• json

Classes

• Nameable
• Stringifiable

luaserialization

The library that implements various auxiliary functions for serialization.

Disclaimer: this library was written directly on an Android smartphone with the QLua IDE.

Features

- data.to_data() function — this function recursively calls the __data() metamethod if it exists:
  - supports for enhancing tables with the __name metaproperty;
- Nameable mixin — this mixin adds the __name metaproperty to a class created by library [middleclass](https://github.com/kikito/middleclass); this metaproperty equals to the name property of the mix target class;
- serialization to string:
  - string.to_string() function — this function calls the data.to_data() function and then applies library [inspect.lua](https://github.com/kikito/inspect.lua);
  - Stringifiable mixin — this mixin adds the __tostring() metamethod that calls the string.to_string() function;
- serialization to JSON:
  - json.to_json() function — this function calls the data.to_data() function and then transforms the data into the JSON;
  - json.from_json() function — this function transforms the text in the JSON to a data:
    - optionally, it can validate the data against a JSON Schema;
    - optionally, it can recreate tables with the __name property with the passed constructors.

Installation

 $ luarocks install luaserialization

License

The MIT License (MIT)

Copyright © 2024 thewizardplusplus