.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Config::MVP::Reader 3"
.TH Config::MVP::Reader 3 2026-10-26 "perl v5.44.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Config::MVP::Reader::YAML; # this doesn\*(Aqt really exist
\&
\&  my $reader   = Config::MVP::Reader::YAML\->new;
\&
\&  my $sequence = $reader\->read_config(\*(Aq/etc/foobar.yml\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Config::MVP::Reader exists to read configuration data from storage (like a
file) and convert that data into instructions to a Config::MVP::Assembler,
which will in turn convert them into a Config::MVP::Sequence, the final
product.
.PP
If true (which it is by default) then the current working directly will be
locally added to \f(CW@INC\fR during config loading.  This helps deal with changes
made in Perl v5.26.1.
.PP
.Vb 1
\&  my $sequence = $reader\->read_config($location, \e%arg);
.Ve
.PP
This method is passed a location, which has no set meaning, but should be the
mechanism by which the Reader is told how to locate configuration.  It might be
a file name, a hashref of parameters, a DBH, or anything else, depending on the
needs of the specific Reader subclass.
.PP
It is also passed a hashref of arguments, of which there is only one valid
argument:
.PP
.Vb 1
\& assembler \- the Assembler object into which to read the config
.Ve
.PP
If no assembler argument is passed, one will be constructed by calling the
Reader\*(Aqs \f(CW\*(C`build_assembler\*(C'\fR method.
.PP
Subclasses should generally not override \f(CW\*(C`read_config\*(C'\fR, but should instead
implement a \f(CW\*(C`read_into_assembler\*(C'\fR method, described below.  If a subclass
\&\fIdoes\fR override \f(CW\*(C`read_config\*(C'\fR it should take care to respect the
\&\f(CW\*(C`add_cwd_to_lib\*(C'\fR attribute, above.
.PP
This method should not be called directly.  It is called by \f(CW\*(C`read_config\*(C'\fR with
the following parameters:
.PP
.Vb 1
\&  my $sequence = $reader\->read_into_assembler( $location, $assembler );
.Ve
.PP
The method should read the configuration found at \f(CW$location\fR and use it to
instruct the \f(CW$assembler\fR (a Config::MVP::Assembler) what configuration to
perform.
.PP
The default implementation of this method will throw an exception complaining
that it should have been implemented by a subclass.
.PP
If no Assembler is provided to \f(CW\*(C`read_config\*(C'\fR\*(Aqs \f(CW\*(C`assembler\*(C'\fR parameter, this
method will be called on the Reader to construct one.
.PP
It must return a Config::MVP::Assembler object, and by default will return an
entirely generic one.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 24:" 4
.IX Item "Around line 24:"
Unknown directive: =attr
.IP "Around line 38:" 4
.IX Item "Around line 38:"
Unknown directive: =method
.IP "Around line 82:" 4
.IX Item "Around line 82:"
Unknown directive: =method
.IP "Around line 102:" 4
.IX Item "Around line 102:"
Unknown directive: =method