Packages

dune

0.2.3
0.3.17 0.3.16 0.3.15 0.3.14 0.3.13 0.3.12 0.3.11 0.3.10 0.3.9 0.3.8 0.3.7 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.6 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.2 0.1.1 0.1.0

A sandbox for Elixir to safely evaluate untrusted code from user input

HexDocs

Current section

Files

Jump to
Readme
28 Versions
0 Dependencies
Dependants
Files
Activity
dune lib dune success.ex
Raw

lib/dune/success.ex 

defmodule Dune.Success do

  @moduledoc """

  A struct returned when `Dune` evaluation succeeds.



  Fields:

  - `value` (term): the value which was actually returned at runtime.

    Should not be displayed to the user, might be different from what the user expects.

  - `inspected` (string): safely inspected `value` to be displayed to the user

  - `stdio` (string): captured standard output



  `value` contains the actual value used at runtime, so atoms will be different from the ones

  displayed to the user (see `Dune.eval_string/2`).

  """



  @type t :: %__MODULE__{

          value: term,

          inspected: String.t(),

          stdio: binary

        }

  @enforce_keys [:value, :inspected, :stdio]

  defstruct [:value, :inspected, :stdio]

end