Mead.Session.Turn (mead v0.1.1)

One exchange in a conversation: the input, the output once known, and how it ended.

Summary

status()

t()

Closes a turn with its final status and, when there is one, its output.

interrupt(turn)

Marks a turn that was still in progress as interrupted; any other turn is unchanged.

start(input)

Builds a turn that has just started and has no output yet.

@type status() :: :in_progress | :ok | :failed | :timeout | :interrupted

@type t() :: %Mead.Session.Turn{
  input: term(),
  output: term(),
  started_at: DateTime.t(),
  status: status()
}

@spec finish(t(), status(), term()) :: t()

Closes a turn with its final status and, when there is one, its output.

@spec interrupt(t()) :: t()

Marks a turn that was still in progress as interrupted; any other turn is unchanged.

@spec start(term()) :: t()

Builds a turn that has just started and has no output yet.