NAME

Attean::API::Parser - Parser role

VERSION

This document describes Attean::API::Parser version 0.033

DESCRIPTION

The Attean::API::Parser role defines a common API for all parsers of typed objects from data (either a byte string or a filehandle).

ATTRIBUTES

The following attributes exist:

"handler"

A code reference that will be called during callback-variant parsing methods. This attribute has a default (no-op function), so specifying it is not necessary if using iterator- or list-variant parsing methods.

REQUIRED METHODS

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

"canonical_media_type"

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

"media_types"

Returns an ARRAY reference of media type strings that are acceptable as input to this parser.

"handled_type"

Returns a Type::Tiny object representing the type of items that result from parsing.

"file_extensions"

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

"new_iri( value => $value )"

Constructs and returns a new Attean::IRI object, respecting the parser's "lazy_iris" attribute.

BUGS

Please report any bugs or feature requests to through the GitHub web interface at <https://github.com/kasei/attean/issues>.

SEE ALSO

AUTHOR

Gregory Todd Williams "<gwilliams@cpan.org>"

COPYRIGHT

Copyright (c) 2014--2022 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.