Attean::API::Serializer3pm

Version

This document describes Attean::API::Serializer version 0.035

Overview

The Attean::API::Serializer role defines a common API for all serializers of typed objects to data (either a byte string or printed to a filehandle).

Required methods

The following methods are required by the Attean::API::Serializer role:

"canonical_media_type"

Returns the canonical media type string for the format of this serializer.

"media_types"

Returns an ARRAY reference of media type strings that also identify the format produced by this serializer.

"handled_type"

Returns a Type::Tiny object representing the type of items that are consumed during serialization.

"file_extensions"

Returns an ARRAY reference of file extensions commonly associated with the media types supported by the serializer (and returned by "media_types"). File extensions should NOT include a leading dot.

"serialize_iter_to_io( $fh, $iterator )"

Serializes the elements from the Attean::API::Iterator $iterator to the IO::Handle object $fh.

serialize_iter_to_bytes( $fh )

Serializes the elements from the Attean::API::Iterator $iterator and returns the serialization as a UTF-8 encoded byte string.

Methods

This role provides default implementations of the following methods:

"serialize_list_to_io( $fh, @elements )"

Serializes the objects in @elements to the IO::Handle object $fh.

serialize_list_to_bytes( @elements )

Serializes the objects in @elements and returns the serialization as a UTF-8 encoded byte string.