Packages

bb

0.15.2
0.22.1 0.22.0 0.21.0 0.20.3 0.20.2 0.20.1 0.20.0 0.19.0 0.18.0 0.17.1 0.17.0 0.16.0 0.15.4 0.15.3 0.15.2 0.15.1 0.15.0 0.14.0 0.13.2 0.13.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.2.0

Beam Bots - The framework for resilient robotics.

HexDocs

Current section

Files

Jump to
Readme
33 Versions
7 Dependencies
17 Dependants
Files
Activity
bb lib bb command event.ex
Raw

lib/bb/command/event.ex 

# SPDX-FileCopyrightText: 2025 James Harton

#

# SPDX-License-Identifier: Apache-2.0



defmodule BB.Command.Event do

  @moduledoc """

  Payload type for command execution events.



  Published to `[:command, command_name, execution_id]` path during command lifecycle.

  """



  defstruct [:status, :data]



  use BB.Message,

    schema: [

      status: [

        type: {:in, [:started, :succeeded, :failed, :cancelled]},

        required: true,

        doc: "The command execution status"

      ],

      data: [

        type: :map,

        default: %{},

        doc: "Additional data associated with the event"

      ]

    ]



  @type status :: :started | :succeeded | :failed | :cancelled



  @type t :: %__MODULE__{

          status: status(),

          data: map()

        }

end