.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Catmandu::Importer 3pm"
.TH Catmandu::Importer 3pm "2014-10-14" "perl v5.20.1" "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 "NAME"
Catmandu::Importer \- Namespace for packages that can import
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package Catmandu::Importer::Hello;
\&
\&    use Catmandu::Sane;
\&    use Moo;
\&
\&    with \*(AqCatmandu::Importer\*(Aq;
\&
\&    sub generator {
\&        my ($self) = @_;
\&        state $fh = $self\->fh;
\&        my $n = 0;
\&        return sub {
\&            $self\->log\->debug("generating record " . ++$n);
\&            my $name = $self\->readline;
\&            return defined $name ? { "hello" => $name } : undef;
\&        };
\&    } 
\&
\&    package main;
\&
\&    use Catmandu;
\&
\&    my $importer = Catmandu\->importer(\*(AqHello\*(Aq, file => \*(Aq/tmp/names.txt\*(Aq);
\&    $importer\->each(sub {
\&        my $items = shift;
\&        .
\&        .
\&        .
\&    });
\&
\&    # Or on the command line
\&    $ catmandu convert Hello to YAML < /tmp/names.txt
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Catmandu::Importer is a Perl package that can import data from an external
source (a file, the network, ...). Most importers read from an input stream, 
such as \s-1STDIN,\s0 a given file, or an \s-1URL\s0 to fetch data from, so this base class
provides helper method for consuming the input stream once.
.PP
Every Catmandu::Importer is a Catmandu::Fixable and thus inherits a 'fix'
parameter that can be set in the constructor. When given then each item returned
by the generator will be automatically Fixed using one or more Catmandu::Fixes.
E.g.
.PP
.Vb 4
\&    my $importer = Catmandu\->importer(\*(AqHello\*(Aq,fix => [\*(Aqupcase(hello)\*(Aq]);
\&    $importer\->each( sub {
\&        my $item = shift ; # Every item will be upcased... 
\&    } );
.Ve
.PP
Every Catmandu::Importer is a Catmandu::Iterable and inherits the methods (\f(CW\*(C`first\*(C'\fR,
\&\f(CW\*(C`each\*(C'\fR, \f(CW\*(C`to_array\*(C'\fR...) etc.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.IP "file" 4
.IX Item "file"
Read input from a local file given by its path. Alternatively a scalar
reference can be passed to read from a string.
.IP "fh" 4
.IX Item "fh"
Read input from an IO::Handle. If not specified, Catmandu::Util::io is used to
create the input stream from the \f(CW\*(C`file\*(C'\fR argument or by using \s-1STDIN.\s0
.IP "encoding" 4
.IX Item "encoding"
Binmode of the input stream \f(CW\*(C`fh\*(C'\fR. Set to \f(CW\*(C`:utf8\*(C'\fR by default.
.IP "fix" 4
.IX Item "fix"
An \s-1ARRAY\s0 of one or more fixes or file scripts to be applied to imported items.
.SH "METHODS"
.IX Header "METHODS"
.SS "readline"
.IX Subsection "readline"
Read a line from the input stream. Equivalent to \f(CW\*(C`$importer\->fh\->getline\*(C'\fR.
.SS "readall"
.IX Subsection "readall"
Read the whole input stream as string.
.SS "first, each, rest , ..."
.IX Subsection "first, each, rest , ..."
See Catmandu::Iterable for all inherited methods.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catmandu::Iterable , Catmandu::Fix ,
Catmandu::Importer::CSV, Catmandu::Importer::JSON , Catmandu::Importer::YAML