Temp

Source

Summary

cleanup(tracker \\ get_tracker!, opts \\ [])

Cleans up the temporary files tracked

mkdir!(options \\ %{})

Same as mkdir/1, but raises an exception on failure. Otherwise, returns a temporary directory path

mkdir(options \\ %{})

Returns {:ok, dir_path} where dir_path is the path is the path of the created temporary directory. Returns {:error, reason} if a failure occurs

open!(options \\ nil, func \\ nil)

Same as open/1, but raises an exception on failure

open(options \\ nil, func \\ nil)

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. Returns {:error, reason} if a failure occurs

path!(options \\ nil)

Same as path/1, but raises an exception on failure. Otherwise, returns a temporary path

path(options \\ nil)

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

track!()

Same as track/1, but raises an exception on failure. Otherwise, returns :ok

track()

Returns :ok when the tracking server used to track temporary files started properly

tracked(tracker \\ get_tracker!)

Return the paths currently tracked

Types

options :: nil | Path.t | map

Functions

cleanup(tracker \\ get_tracker!, opts \\ [])

Specs:

  • cleanup(pid, Keyword.t) :: :ok | {:error, any}

Cleans up the temporary files tracked.

Source
mkdir(options \\ %{})

Specs:

Returns {:ok, dir_path} where dir_path is the path is the path of the created temporary directory. Returns {:error, reason} if a failure occurs.

Source
mkdir!(options \\ %{})

Specs:

Same as mkdir/1, but raises an exception on failure. Otherwise, returns a temporary directory path.

Source
open(options \\ nil, func \\ nil)

Specs:

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. Returns {:error, reason} if a failure occurs.

Source
open!(options \\ nil, func \\ nil)

Specs:

Same as open/1, but raises an exception on failure.

Source
path(options \\ nil)

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.

Source
path!(options \\ nil)

Specs:

Same as path/1, but raises an exception on failure. Otherwise, returns a temporary path.

Source
track()

Specs:

Returns :ok when the tracking server used to track temporary files started properly.

Source
track!()

Specs:

  • track! :: pid

Same as track/1, but raises an exception on failure. Otherwise, returns :ok

Source
tracked(tracker \\ get_tracker!)

Return the paths currently tracked.

Source