Help language development. Donate to The Perl Foundation

JSON::Name zef:jonathanstowe last updated on 2022-08-07

d7486670f476871c83d6dbc2c87f665b69d484ab/

JSON::Name

Provide a trait (and Attribute role) for JSON Marshal/Unmarshal where the JSON names aren't Raku identifiers.

Synopsis

use JSON::Name;

class MyClass {
    # The attribute meta object will have the role JSON::Name::NamedAttribute
   # applied and "666.evil.name" will be stored in it's json-name attribute
   has $.nice-name is json-name('666.evil.name');

}

Description

This is released as a dependency of JSON::Marshal and JSON::Unmarshal in order to save duplication, it is intended to store a separate JSON name for an attribute where the name of the JSON attribute might be changed, either for aesthetic reasons or the name is not a valid Raku identifier. It will of course also be needed in classes thar are going to use JSON::Marshal or JSON::Unmarshal for serialisation/de-serialisation.

Of course it could be used in other modules for a similar purpose.

Installation

Assuming you have a working Rakudo installation you should be able to install this with zef :

# From the source directory

zef install .

# Remote installation

zef install JSON::Name

Support

Suggestions/patches are welcomed via github at https://github.com/jonathanstowe/JSON-Name

Licence

This is free software.

Please see the LICENCE file in the distribution