logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Dancer2::Core::Role::Serializer - Role for Serializer engines

Attributes

content_type
       The contenttype of the object after being serialized. For example, a JSON serializer would have a
       application/json content type defined.

Author

       Dancer Core Developers

Configuration

       The serializer configuration variable tells Dancer2 which engine to use.

       You can change it either in your config.yml file:

           #Set JSON engine
           serializer: "JSON"

           # Prettify JSON output
           engines:
             serializer:
               JSON:
                 pretty: 1

       To know which engines are availables please see "Serializers" in Dancer2::Manual

Description

       Any class that consumes this role will be able to be used as a serializer under Dancer2.

       In order to implement this role, the consumer must implement the methods "serialize" and "deserialize",
       and should define the "content_type" attribute value.

Methods

serialize($content,[\%options])
       The serialize method need to be implemented by the consumer. It receives the serializer class object and
       a reference to the object to be serialized. Should return the object after being serialized, in the
       content type defined by the "content_type" attribute.

       A third optional argument is a hash reference of options to the serializer.

       The serialize method must return bytes and therefore has to handle any encoding.

   deserialize($content,[\%options])
       The inverse method of "serialize". Receives the serializer class object and a string that should be
       deserialized. The method should return a reference to the deserialized Perl data structure.

       A third optional argument is a hash reference of options to the serializer.

       The deserialize method receives encoded bytes and must therefore handle any decoding required.

Name

       Dancer2::Core::Role::Serializer - Role for Serializer engines

Version

       version 1.1.2

See Also