ProtonStream.Options (proton_stream v1.8.4)

Validate and normalize the options passed to ProtonStream.open/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(atom, cmd, args, opts)

Validate options and normalize them for invoking commands.

Types

t()

@type t() :: map()

The following fields are always present:

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

The next fields are optional:

:cd
:arg0
:stderr_to_stdout
:capture_stderr_only
:parallelism
:env
:stdio_window
:cgroup_controllers
:cgroup_path
:cgroup_base
:delay_to_sigkill
:cgroup_sets
:uid
:gid
:fake

Functions

validate(atom, cmd, args, opts)

@spec validate(:stream, binary(), [binary()], keyword()) :: t()

Validate options and normalize them for invoking commands.