Temp
SourceSummary
cleanup(tracker) | Cleans up the temporary files tracked by the passed agent |
mkdir!(options \\ %{}, tracker \\ nil) | Same as |
mkdir(options \\ %{}, tracker \\ nil) | Returns |
open!(options \\ nil, func \\ nil) | Same as |
open(options \\ nil, func \\ nil, tracker \\ nil) | Returns |
path!(options \\ nil) | Same as |
path(options \\ nil) | Returns a |
track!() | Same as |
track() | Returns an agent |
Types
Functions
Specs:
- cleanup(pid) :: :ok | {:error, any}
Cleans up the temporary files tracked by the passed agent pid
Specs:
Returns {:ok, dir_path}
where dir_path
is the path is the path of the
created temporary directory.
A tracker agent pid (created by track/1
) can be passed as a second argument
to keep track of the created directory.
Returns {:error, reason}
if a failure occurs.
Specs:
Same as mkdir/1
, but raises an exception on failure. Otherwise, returns
a temporary directory path.
Specs:
- open(options, nil | (File.io_device -> any), nil | pid) :: {:ok, File.io_device, Path.t} | {:error, any}
Returns {:ok, fd, file_path}
if no callback is passed, or {:ok, file_path}
if callback is passed, where fd
is the file descriptor of a temporary file
and file_path
is the path of the temporary file.
When no callback is passed, the file descriptor should be closed.
A tracker agent pid (created by track/1
) can be passed as a second argument
to keep track of the created file.
Returns {:error, reason}
if a failure occurs.
Specs:
- open!(options, pid | nil) :: {File.io_device, Path.t}
Same as open/1
, but raises an exception on failure.
Specs:
Returns a {:ok, path}
where path
is a path that can be used freely in the
system temporary directory, or {:error, reason}
if it fails to get the
system temporary directory.
Specs:
Same as path/1
, but raises an exception on failure. Otherwise, returns a temporary path.
Specs:
- track :: Agent.on_start
Returns an agent pid
used to track temporary files
Specs:
- track! :: pid
Same as track/1
, but raises an exception on failure. Otherwise, returns the tracker pid
.