temp v0.4.7 Temp View Source

Link to this section Summary

Functions

Cleans up the temporary files tracked

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

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

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

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

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

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

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

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

Return the paths currently tracked

Link to this section Types

Link to this type options() View Source
options() :: nil | Path.t() | map()

Link to this section Functions

Link to this function cleanup(tracker \\ get_tracker!(), opts \\ []) View Source
cleanup(pid(), Keyword.t()) :: :ok | {:error, any()}

Cleans up the temporary files tracked.

Link to this function mkdir!(options \\ %{}) View Source
mkdir!(options()) :: Path.t() | no_return()

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

Link to this function mkdir(options \\ %{}) View Source
mkdir(options()) :: {:ok, Path.t()} | {:error, any()}

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.

Options

See path/1.

Link to this function open!(options \\ nil, func \\ nil) View Source
open!(options(), pid() | nil) ::
  Path.t() | {File.io_device(), Path.t()} | no_return()

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

Link to this function open(options \\ nil, func \\ nil) View Source
open(options(), nil | (File.io_device() -> any())) ::
  {:ok, Path.t()} | {: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. Returns {:error, reason} if a failure occurs.

Options

See path/1.

Link to this function path!(options \\ nil) View Source
path!(options()) :: Path.t() | no_return()

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

Link to this function path(options \\ nil) View Source
path(options()) :: {:ok, Path.t()} | {:error, String.t()}

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.

Options

The following options can be used to customize the generated path

  • :prefix - prepends the given prefix to the path

  • :suffix - appends the given suffix to the path, this is useful to generate a file with a particular extension

  • :basedir - places the generated file in the designated base directory instead of the system temporary directory

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

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

Link to this function tracked(tracker \\ get_tracker!()) View Source

Return the paths currently tracked.