File::Slurper::Temp - File::Slurper + File::Temp
This document describes version 0.007 of File::Slurper::Temp (from Perl distribution File-Slurper-Temp), released on 2021-08-02.
Use like you would use File::Slurper's write_text and write_binary:
write_text
write_binary
use File::Slurper::Temp qw(write_text write_binary); write_text("/tmp/foo.txt", "some text"); write_binary("/tmp/bar", $somedata);
Use write_text_to_tempfile and write_binary_to_tempfile:
write_text_to_tempfile
write_binary_to_tempfile
use File::Slurper::Temp qw(write_text_to_tempfile write_binary_to_tempfile); my $filename1 = write_text_to_tempfile("some text"); my $filename2 = write_binary_to_tempfile($somedata);
This module is a simple combination of File::Slurper and File::Temp. It provides its version of "write_text" and "write_binary", as well as a couple of functions of its own.
This module's version of write_text and write_binary write to temporary file first using File::Temp's tempfile() before renaming to the final destination path using Perl's rename(). If the destination path is originally a symlink, it will be replaced with a regular file by rename(). This can avoid symlink attack.
rename()
In addition the above two functions, this module also provides "write_text_to_tempfile" and "write_binary_to_tempfile". You don't have to specify destination path but just content to write, and the functions will return the temporary filename created.
Usage:
write_text($filename, $content [ , $encoding, $crlf ])
Just like the original File::Slurper's version, except will write to temporary file created by File::Temp's tempfile first, then rename the temporary file using Perl's rename(). The function will croak if rename() fails.
tempfile
By default, the temporary file is created in the same directory as $filename, using tempfile()'s option DIR => dirname($filename). If you want to set a specific temporary directory, set "$FILE_TEMP_DIR". But keep in mind that rename() doesn't work cross-device.
$filename
tempfile()
DIR => dirname($filename)
By default, if the target file exists, the temporary file is also created with the same permission as the target file. Otherwise, permission is default as per File::Temp's default (0600). If you want to set a specific permission, set "$FILE_TEMP_PERMS". Permission setting is done by File::Temp::tempfile() using its PERMS option.
By default, file ownership is not changed/set. If you run this script as root, you might be creating files owned by root. There's no option yet to set this.
write_binary($filename, $content)
$tempname = write_text_to_tempfile($content [ , $encoding, $crlf ])
Temporary file is created with default option (File::Temp::tempfile()).
File::Temp::tempfile()
$tempname = write_binary_to_tempfile($content)
Please visit the project's homepage at https://metacpan.org/release/File-Slurper-Temp.
Source repository is at https://github.com/perlancar/perl-File-Slurper-Temp.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Slurper-Temp
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.
File::Slurper
File::Temp
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 2019, 2017 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.
To install File::Slurper::Temp, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::Slurper::Temp
CPAN shell
perl -MCPAN -e shell install File::Slurper::Temp
For more information on module installation, please visit the detailed CPAN module installation guide.