NAME

CPAN::Index::Role::Readable - Reads index files

DESCRIPTION

This role provides a collection of utility constructors for CPAN index file objects.

REQUIRES

default_location

Class method that returns a string specifying the path to the default location of this file relative to the repository root.

parse

This class method (generally invoked as part of the construction phase) should accept a string containing an index file, and return a list of key/value pairs suitable for passing to the constructor of the consuming class.

PROVIDES

read_from_string

Construct a new index file object by reading the file contents from a string.

read_from_file

Construct a new index file object by reading the file contents from a filename.

read_from_tarball

Construct a new index file object by reading the file contents from a tarball.

read_from_repo_path

Construct a new index file object by locating and parsing a file in a local repository.

read_from_repo_uri

Construct a new index file object by locating and parsing a file in a remote repository.