runbox v7.0.1

Runbox.Runtime.OutputAction (runbox v7.0.1)

Output Action for internal use by Runtime

Link to this section Summary

Types

t()

Runtime Output Action

Functions

is_oa_body?(params)

Returns true if valid output action body.

new(params, timestamp, scenario_id, run_id)

Creates a new output action.

valid?(arg1)

Returns true if valid output action.

Link to this section Types

Link to this type

t()

@type t() :: %Runbox.Runtime.OutputAction{
  body:
    Runbox.Scenario.OutputAction.oa_params()
    | Runbox.Scenario.OutputAction.BadOutputAction.t(),
  run_id: String.t(),
  scenario_id: String.t(),
  timestamp: integer()
}

Runtime Output Action

Link to this section Functions

Link to this function

is_oa_body?(params)

@spec is_oa_body?(Runbox.Scenario.OutputAction.oa_params() | any()) :: boolean()

Returns true if valid output action body.

Link to this function

new(params, timestamp, scenario_id, run_id)

@spec new(
  params :: Runbox.Scenario.OutputAction.oa_params(),
  integer(),
  String.t(),
  String.t()
) :: t()

Creates a new output action.

To produce a valid output action, the params have to be one of the accepted structs. See the documentation of the particular structs for details.

If the params are not one of the accepted structs or some of the fields do not pass validation, it returns an output action with body set to Runbox.Scenario.OutputAction.BadOutputAction.t/0 with original params inside.

Link to this function

valid?(arg1)

@spec valid?(t() | any()) :: boolean()

Returns true if valid output action.