.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "CPANPLUS::Internals::Source::Memory 3"
.TH CPANPLUS::Internals::Source::Memory 3 2023-07-25 "perl v5.38.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 NAME
CPANPLUS::Internals::Source::Memory \- In memory implementation
.ie n .SS "$cb\->_\|_memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])"
.el .SS "\f(CW$cb\fP\->_\|_memory_retrieve_source(name => \f(CW$name\fP, [path => \f(CW$path\fP, uptodate => BOOL, verbose => BOOL])"
.IX Subsection "$cb->__memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])"
This method retrieves a \fIstorable\fRd tree identified by \f(CW$name\fR.
.PP
It takes the following arguments:
.IP name 4
.IX Item "name"
The internal name for the source file to retrieve.
.IP uptodate 4
.IX Item "uptodate"
A flag indicating whether the file-cache is up-to-date or not.
.IP path 4
.IX Item "path"
The absolute path to the directory holding the source files.
.IP verbose 4
.IX Item "verbose"
A boolean flag indicating whether or not to be verbose.
.PP
Will get information from the config file by default.
.PP
Returns a tree on success, false on failure.
.ie n .SS "$cb\->_\|_memory_save_source([verbose => BOOL, path => $path])"
.el .SS "\f(CW$cb\fP\->_\|_memory_save_source([verbose => BOOL, path => \f(CW$path\fP])"
.IX Subsection "$cb->__memory_save_source([verbose => BOOL, path => $path])"
This method saves all the parsed trees in \fIstorable\fRd format if
\&\f(CW\*(C`Storable\*(C'\fR is available.
.PP
It takes the following arguments:
.IP path 4
.IX Item "path"
The absolute path to the directory holding the source files.
.IP verbose 4
.IX Item "verbose"
A boolean flag indicating whether or not to be verbose.
.PP
Will get information from the config file by default.
.PP
Returns true on success, false on failure.