.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 >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
.\"
.\" 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::DirectoryIndex 3pm"
.TH Catmandu::DirectoryIndex 3pm "2020-05-22" "perl v5.30.2" "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::DirectoryIndex \- A base role to store relations between id's and directories
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyDirectory;
\&
\&    use Moo;
\&    use File::Spec;
\&    use File:Basename;
\&    use Path::Tiny qw(path);
\&
\&    with "Catmandu::DirectoryIndex";
\&
\&    # translate id to directory
\&    sub _to_path {
\&        my ( $self, $id ) = @_;
\&        File::Spec\->catdir( $self\->base_dir(), $id );
\&    }
\&
\&    sub get {
\&        my ( $self, $id ) = @_;
\&        my $path = $self\->_to_path( $id );
\&
\&        is_string( $path ) && \-d $path ? { _id => $id, _path => $path } : undef;
\&    }
\&
\&    sub add {
\&        my ( $self, $id ) = @_;
\&        my $path = $self\->_to_path( $id );
\&
\&        path( $path )\->mkpath unless \-d $path;
\&
\&        { _id => $id, _path => $path };
\&    }
\&
\&    sub delete {
\&        my ( $self, $id ) = @_;
\&        my $path = $self\->_to_path( $id );
\&
\&        if ( is_string( $path ) && \-d $path ) {
\&            path( $path )\->remove_tree();
\&        }
\&    }
\&
\&    sub delete_all {
\&        path( $_[0]\->base_dir )\->remove_tree({ keep_root => 1 });
\&    }
\&
\&    # return a generator that returns list of records, that maps _id and _path
\&    sub generator {
\&        my $self = $_[0];
\&        return sub {
\&            state $records;
\&
\&            if ( !defined( $records ) ) {
\&                $records = [];
\&
\&                opendir my $dh, $self\->base_dir() or die($!);
\&                while( my $entry = readdir( $dh ) ){
\&                    if ( \-d $entry ) {
\&                        push @$records, {
\&                            _id => $entry,
\&                            _path => File::Spec\->catfile( $self\->base_dir, $entry )
\&                        };
\&                    }
\&                }
\&                closedir $dh;
\&            }
\&
\&            shift( @$records );
\&        };
\&    }
\&
\&    package main;
\&
\&    my $p = MyDirectory\->new( base_dir => "/tmp" );
\&
\&    Catmandu\->store\->bag\->each(sub {
\&        my $r = $_[0];
\&        my $mapping = $p\->get( $r\->{_id} ) || $p\->add( $r\->{_id} );
\&        say $id . " => " . $mapping\->{path};
\&    });
.Ve
.SH "CLASS METHODS AVAILABLE"
.IX Header "CLASS METHODS AVAILABLE"
.ie n .SS "new( base_dir => $base_dir )"
.el .SS "new( base_dir => \f(CW$base_dir\fP )"
.IX Subsection "new( base_dir => $base_dir )"
.IP "base_dir" 4
.IX Item "base_dir"
The base directory where the files are stored. Required
.SH "METHODS AVAILABLE"
.IX Header "METHODS AVAILABLE"
.IP "base_dir" 4
.IX Item "base_dir"
.SH "METHODS TO IMPLEMENT"
.IX Header "METHODS TO IMPLEMENT"
Implementors must implement these methods
.ie n .IP "add( $id ) : $mapping" 4
.el .IP "add( \f(CW$id\fR ) : \f(CW$mapping\fR" 4
.IX Item "add( $id ) : $mapping"
* Accepts \f(CW$id\fR as string
.Sp
* Translates \f(CW$id\fR to directory path
.Sp
* Creates directory if necessary
.Sp
* Returns \s-1HASH\s0 with keys \f(CW\*(C`_id\*(C'\fR and \f(CW\*(C`_path\*(C'\fR
.Sp
This method should throw an Catmandu::Error when it detects an invalid id.
.Sp
It should either return the mapping or throw an error.
.ie n .IP "get( $id ) : $mapping" 4
.el .IP "get( \f(CW$id\fR ) : \f(CW$mapping\fR" 4
.IX Item "get( $id ) : $mapping"
* Accepts \f(CW$id\fR as string
.Sp
* Translates \f(CW$id\fR to directory path
.Sp
* Returns \s-1HASH\s0 with keys \f(CW\*(C`_id\*(C'\fR and \f(CW\*(C`_path\*(C'\fR, if a path exists for \f(CW$id\fR
.Sp
This method should throw an Catmandu::Error when it detects an invalid id.
.Sp
Difference with method \*(L"add\*(R":
.Sp
* no directory created
.Sp
* no mapping returned if no existing directory could be found
.ie n .IP "delete ( $id )" 4
.el .IP "delete ( \f(CW$id\fR )" 4
.IX Item "delete ( $id )"
* Accepts id as string
.Sp
* Translates id to directory
.Sp
* Removes directory if it exists
.Sp
* Do other internal cleanup actions if any required
.Sp
This method should throw an Catmandu::Error when at failure.
.IP "\fBdelete_all()\fR" 4
.IX Item "delete_all()"
* Deletes files/directories in base_dir. Please keep the base_dir.
.Sp
* Do other internal cleanup actions if any required
.Sp
This method should throw an Catmandu::Error when at failure.
.IP "\fBgenerator()\fR" 4
.IX Item "generator()"
Inherited requirement from Catmandu::Iterable:
.Sp
* return function reference
.Sp
* every call to this function must return the next directory entry in the index
as a \s-1HASH\s0 with keys \f(CW\*(C`_id\*(C'\fR and \f(CW\*(C`path\*(C'\fR
.SH "INHERITED METHODS"
.IX Header "INHERITED METHODS"
This Catmandu::DirectoryIndex inherits:
.IP "Catmandu::Iterable" 3
.IX Item "Catmandu::Iterable"
So all functions from Catmandu::Iterable are available to these objects.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catmandu::Store::File::Simple ,
Catmandu::DirectoryIndex::UUID ,
Catmandu::DirectoryIndex::Number ,
Catmandu::DirectoryIndex::Map