Raxol.Sequence (Raxol v2.0.1)

View Source

Represents a sequence of commands for benchmarking and testing.

Summary

Functions

Adds metadata to a sequence.

Gets metadata from a sequence.

Creates a new sequence with the given name and steps.

Gets the number of steps in a sequence.

Validates that a sequence has the required fields.

Types

t()

@type t() :: %Raxol.Sequence{
  metadata: map() | nil,
  name: String.t(),
  steps: [String.t()]
}

Functions

add_metadata(sequence, metadata)

@spec add_metadata(t(), map()) :: t()

Adds metadata to a sequence.

get_metadata(sequence, key, default \\ nil)

@spec get_metadata(t(), String.t() | atom(), any()) :: any()

Gets metadata from a sequence.

new(name, steps, metadata \\ %{})

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

Creates a new sequence with the given name and steps.

step_count(sequence)

@spec step_count(t()) :: non_neg_integer()

Gets the number of steps in a sequence.

valid?(arg1)

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

Validates that a sequence has the required fields.