Statifier.Event (statifier v1.9.0)

View Source

Represents an event that can be sent to a state chart.

Events can be external (from outside the state chart) or internal (generated by the state chart itself, e.g., from <raise> actions).

Summary

Types

origin()
t()

Functions

external?(event)

Check if an event is external.

internal(name, data \\ %{})

Create a new internal event.

internal?(event)

Check if an event is internal.

matches?(event, name)

Check if this event matches a transition's event specification.

new(name, data \\ %{})

Create a new external event.

Types

origin()

@type origin() :: :external | :internal

t()

@type t() :: %Statifier.Event{data: map(), name: String.t(), origin: origin()}

Functions

external?(event)

@spec external?(t()) :: boolean()

Check if an event is external.

internal(name, data \\ %{})

@spec internal(String.t(), map()) :: t()

Create a new internal event.

internal?(event)

@spec internal?(t()) :: boolean()

Check if an event is internal.

matches?(event, name)

@spec matches?(t(), String.t() | nil) :: boolean()

Check if this event matches a transition's event specification.

Supports SCXML event matching patterns:

  • Universal wildcard: "*" matches any event
  • Prefix matching: "foo" matches "foo", "foo.bar", "foo.bar.baz"
  • Multiple descriptors: "foo bar" matches "foo" OR "bar" (and their prefixes)
  • Wildcard suffix: "foo.*" matches "foo.bar", "foo.baz" (but not "foo")

new(name, data \\ %{})

@spec new(String.t(), map()) :: t()

Create a new external event.