Packages
gleam_erlang
1.3.0
1.3.0
1.2.0
1.1.0
1.0.0
1.0.0-rc1
0.34.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.1
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.1
0.18.0
0.18.0-rc1
retired
0.17.1
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
Types and functions for programs running on Erlang!
Current section
Files
Jump to
Current section
Files
src/gleam@erlang@application.erl
-module(gleam@erlang@application).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/gleam/erlang/application.gleam").
-export([priv_directory/1]).
-export_type([start_type/0]).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
?MODULEDOC(
" An Erlang application is a collection of code that can be loaded into the\n"
" Erlang virtual machine and even started and stopped if they define a\n"
" start module and supervision tree. Each Gleam package is an Erlang\n"
" application.\n"
).
-type start_type() :: normal |
{takeover, gleam@erlang@node:node_()} |
{failover, gleam@erlang@node:node_()}.
-file("src/gleam/erlang/application.gleam", 37).
?DOC(
" Returns the path of an application's `priv` directory, where extra non-Gleam\n"
" or Erlang files are typically kept. Each Gleam package is an Erlang\n"
" application.\n"
"\n"
" Returns an error if no application was found with the given name.\n"
"\n"
" # Example\n"
"\n"
" ```gleam\n"
" application.priv_directory(\"my_app\")\n"
" // -> Ok(\"/some/location/my_app/priv\")\n"
" ```\n"
).
-spec priv_directory(binary()) -> {ok, binary()} | {error, nil}.
priv_directory(Name) ->
gleam_erlang_ffi:priv_directory(Name).