The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

PERLANCAR / File-Temp-MoreUtils-0.005 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

              
NAME
    File::Temp::MoreUtils - Provide more routines related to creating
    temporary files/dirs
VERSION
    This document describes version 0.005 of File::Temp::MoreUtils (from
    Perl distribution File-Temp-MoreUtils), released on 2021-07-20.
SYNOPSIS
FUNCTIONS
  tempdir_named
    Usage:
     tempdir_named(%args) -> any
    Try to create a temporary directory with certain name (but used .1, .2,
    ... suffix if already exists) .
    Examples:
    *   Attempt to create /foo/source.dir/, and if already exists
        /foo/source.1.dir/ instead, and so on:
         tempdir_named(name => "/foo/source.dir");
    *   Attempt to create source/ inside another temporary directory, and if
        already exists source.1/, and so on:
         tempdir_named(name => "source", dir => undef);
    *   Attempt to create source.dir/, and if already exists
        source.tmp1.dir/, then source.tmp2.pdf, and so on:
         tempdir_named(name => "source.dir", suffix_start => "tmp1");
    This is similar to "tempfile_named()", but since there is no "O_EXCL"
    flag similar to opening a file, there is a race condition possible where
    you create a certain temporary directory and before you open/read the
    directory, someone else has replaced the directory with another.
    Therefore it is best if you create the specifically-named temporary
    directory *inside* another temporary directory.
    Like File::Temp's "tempdir()", it will return the path of the created
    temporary directory:
     $dir
    This function is not exported by default, but exportable.
    Arguments ('*' denotes required arguments):
    *   dir => *dirname*
        If specified, will create the temporary directory here.
        If specified and set to "undef", will create new temporary directory
        using File::Temp's "tempdir" (with CLEANUP option set to true unless
        DEBUG environment variable is set to true) and use this temporary
        directory for the directory, including for subsequent invocation for
        the same process whenever "dir" is set to "undef" again.
    *   name* => *filename*
    *   suffix_start => *str* (default: 1)
        Will use Perl's post-increment operator ("++") to increment the
        suffix, so this works with number as well as letter combinations,
        e.g. "aa" will be incremented to "ab", "ac" and so on.
    Return value: (any)
  tempfile_named
    Usage:
     tempfile_named(%args) -> any
    Try to create a temporary file with certain name (but used .1, .2, ...
    suffix if already exists) .
    Examples:
    *   Attempt to create source.pdf, and if already exists source.1.pdf,
        and so on:
         tempfile_named(name => "source.pdf");
    *   Attempt to create source.pdf in a temporary directory, and if
        already exists source.1, and so on:
         tempfile_named(name => "source", dir => undef);
    *   Attempt to create source.pdf, and if already exists source.tmp1.pdf,
        then source.tmp2.pdf, and so on:
         tempfile_named(name => "source.pdf", suffix_start => "tmp1");
    Unlike File::Temp's "tempfile()" which creates a temporary file with a
    unique random name, this routine tries to create a temporary file with a
    specific name, but adds a counter suffix when the specified name already
    exists. Care has been taken to avoid race condition (using "O_EXCL" flag
    of "sysopen"). This is often desirable in the case when we want the
    temporary file to have a name similarity with another file.
    And like File::Temp's "tempfile()", will return:
     ($fh, $filename)
    This function is not exported by default, but exportable.
    Arguments ('*' denotes required arguments):
    *   dir => *dirname*
        If specified, will create the temporary file here.
        If specified and set to "undef", will create new temporary directory
        using File::Temp's "tempdir" (with CLEANUP option set to true unless
        DEBUG environment variable is set to true) and use this temporary
        directory for the directory, including for subsequent invocation for
        the same process whenever "dir" is set to "undef" again.
    *   name* => *filename*
    *   suffix_start => *str* (default: 1)
        Will use Perl's post-increment operator ("++") to increment the
        suffix, so this works with number as well as letter combinations,
        e.g. "aa" will be incremented to "ab", "ac" and so on.
    Return value: (any)
ENVIRONMENT
  DEBUG
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/File-Temp-MoreUtils>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-File-Temp-MoreUtils>.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=File-Temp-MoreUtils>
    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
    File::Temp
AUTHOR
    perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2021 by perlancar@cpan.org.
    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.