MuonTrap.Options (muontrap v1.6.1)

Validate and normalize the options passed to MuonTrap.cmd/3 and MuonTrap.Daemon.start_link/3

This module is generally not called directly, but it's likely the source of exceptions if any options aren't quite right. Call validate/4 directly to debug or check options without invoking a command.

Summary

Types

t()

The following fields are always present

Functions

validate(context, cmd, args, opts)

Validate options and normalize them for invoking commands

Types

t()

@type t() :: map()

The following fields are always present:

:cmd - the command to run
:args - a list of arguments to the command

The next fields are optional:

:into - MuonTrap.cmd/3 only
:cd
:arg0
:stderr_to_stdout
:parallelism
:env
:name - MuonTrap.Daemon-only
:logger_fun - MuonTrap.Daemon-only
:log_output - MuonTrap.Daemon-only, ignored if logger_fun is set
:log_prefix - MuonTrap.Daemon-only, ignored if logger_fun is set
:log_transform - MuonTrap.Daemon-only, ignored if logger_fun is set
:logger_metadata - MuonTrap.Daemon-only, ignored if logger_fun is set and doesn't call the Elixir Logger
:stdio_window
:exit_status_to_reason - MuonTrap.Daemon-only
:cgroup_controllers
:cgroup_path
:cgroup_base
:delay_to_sigkill
:cgroup_sets
:uid
:gid
:timeout - MuonTrap.cmd/3 only

Functions

validate(context, cmd, args, opts)

@spec validate(:cmd | :daemon, binary(), [binary()], keyword()) :: t()

Validate options and normalize them for invoking commands

Pass in :cmd or :daemon for the first parameter to allow function-specific options.