This is the temporary-file Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:52:41 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
temporary-fileTemporary file creation library
Hans Hübner <hans.huebner@gmail.com>
BSD
alexandria (system).
bordeaux-threads (system).
cl-fad (system).
cl-ppcre (system).
unit-test (system).
temporary-file.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
temporary-file/temporary-file.asdtemporary-file (system).
temporary-file/temporary-file.lisptemporary-file (system).
*default-template* (special variable).
cannot-create-temporary-file (condition).
invalid-temporary-pathname-template (condition).
open-temporary (function).
with-open-temporary-file (macro).
with-output-to-temporary-file (macro).
*create-file-name-lock* (special variable).
*max-tries* (special variable).
*name-random-state* (special variable).
directory-from-environment (function).
generate-random-pathname (function).
generate-random-string (function).
get-default-temporary-directory (function).
getenv (function).
with-file-name-lock-held (macro).
Packages are listed by definition order.
temporary-filecommon-lisp.
*default-template* (special variable).
cannot-create-temporary-file (condition).
invalid-temporary-pathname-template (condition).
open-temporary (function).
with-open-temporary-file (macro).
with-output-to-temporary-file (macro).
*create-file-name-lock* (special variable).
*max-tries* (special variable).
*name-random-state* (special variable).
directory-from-environment (function).
generate-random-pathname (function).
generate-random-string (function).
get-default-temporary-directory (function).
getenv (function).
with-file-name-lock-held (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Create a temporary file using OPEN-TEMPORARY with ARGS and run BODY with STREAM bound to the temporary file stream. Returns the values returned by BODY. By default, the file is deleted when BODY is exited. If a true value is passed in KEEP, the file is not deleted when the body is exited. See OPEN-TEMPORARY for more permitted options.
Create a temporary file using OPEN-TEMPORARY with ARGS and run BODY with STREAM bound to the temporary file stream. Returns the pathname of the file that has been created. See OPEN-TEMPORARY for permitted options.
Create a file with a randomly generated name and return the opened
stream. The resulting pathname is generated from TEMPLATE, which
is a string representing a pathname template. A percent sign (%)
in that string is replaced by a randomly generated string to make
the filename unique. The default for TEMPLATE places temporary
files in the TEMPORARY-FILES logical pathname host, which is
automatically set up in a system specific manner. The file name
generated from TEMPLATE is merged with *DEFAULT-PATHNAME-DEFAULTS*,
so random pathnames relative to that directory can be generated by
not specifying a directory in TEMPLATE.
GENERATE-RANDOM-STRING can be passed to override the default
function that generates the random name component. It should
return a random string consisting of characters that are permitted
in a pathname (logical or physical, depending on TEMPLATE).
The name of the temporary file can be accessed calling the PATHNAME
function on STREAM. For convenience, the temporary file is opened
on the physical pathname, i.e. if the TEMPLATE designate a logical
pathname the translation to a physical pathname is performed before
opening the stream.
In order to create a unique file name, OPEN-TEMPORARY may loop internally up to MAX-TRIES times before giving up and signalling a CANNOT-CREATE-TEMPORARY-FILE condition.
error.
common-lisp.
:string
Query the libc runtime environment. See getenv(3).
| Jump to: | D F G M O W |
|---|
| Jump to: | D F G M O W |
|---|
| Jump to: | *
M S T |
|---|
| Jump to: | *
M S T |
|---|
| Jump to: | C F I P S T |
|---|
| Jump to: | C F I P S T |
|---|