.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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
.\" ========================================================================
.\"
.IX Title "AnyData::Storage::File 3pm"
.TH AnyData::Storage::File 3pm "2023-08-06" "perl v5.36.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"
.Vb 1
\& AnyData::Storage::File \-\- manipulate files with rich warnings
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 2
\& Opens, reads from, writes to, creates and destroys files with numerous
\& options for error handling, flocking, binmode, etc.
\&
\& The simplest form is the equivalent of
\&
\&       my $f    = AnyData::Storage::File\->new(dirs=>\e@dirs,flock=>1);
\&       my $str1 = $f\->adSlurp($file);
\&
\&       
\&       for( @dirs ) {
\&           open(IN,$file) or die $!;
\&       }
\&       sub slurp {
\&           local *IN;
\&           local $/ = undef;
\&       }
\&
\& But, depending on how you set the default behaviour
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\& use AnyData;
\& my $f = AnyData::Storage::File\->new;
\& $f\->set(\*(Aqbinmode\*(Aq,1|0);
\& $f\->set(\*(AqPrintError\*(Aq,1|0);
\& $f\->set(\*(AqRaiseError\*(Aq,1|0);
\& $f\->set(\*(AqTrace\*(Aq,1|0);
\& $f\->set(\*(Aqf_dir\*(Aq,$dir|$dir_array)
.Ve
.PP
<  input, fail if doesn't exist
>  output, truncate if exists, create if doesn't
>> append, create if doesn't exist
+< read/write, fail if doesn't exist
.PP
r  = <
r+ =
.SH "\fBnew()\fP"
.IX Header "new()"
.Vb 1
\& my $f = AnyData::Storage::File\->new;
\&
\& or
\&
\& my $f = AnyData::Storage::File\->new( %flags );
\&
\& %flags is a hash which can contain any or all of:
\&
\&     f_dir      => $directory,   # defaults to \*(Aq./\*(Aq (
\&     binmode    => $binmode,     # defaults to 0 (doesn\*(Aqt binmode files)
\&     printError => $warnings,    # defaults to 1 (print warning on errors)
.Ve
.ie n .SH "open_local_file( $fname, $mode );"
.el .SH "open_local_file( \f(CW$fname\fP, \f(CW$mode\fP );"
.IX Header "open_local_file( $fname, $mode );"
.Vb 1
\& Mode is one of
\&
\& a = append     open for reading & writing, create if doesn\*(Aqt exist
\& r = read       open for reading, fail if doesn\*(Aqt exist
\& u = open       open for reading & writing, fail if doesn\*(Aqt exist
\& c = create     open for reading & writing, fail if it already exists
\& o = overwrite  open for reading & writing, overwrite if it already exists
\&
\& Additionally, all modes fail if the file can\*(Aqt be opened.  On systems
\& that support flock, \*(Aqr\*(Aq fails if a shared lock can not be obtained; the
\& other modes fail if an exclusive lock can\*(Aqt be obtained.
.Ve