CliSubprocessCore.Payload.Result (CliSubprocessCore v0.4.1)

Represents the terminal result of a provider CLI run.

Summary

Types

t()

Terminal result of a provider CLI run.

Functions

new(attrs \\ [])

parse(payload)

parse!(payload)

schema()

to_map(payload)

Types

t()

@type t() :: %CliSubprocessCore.Payload.Result{
  extra: map(),
  metadata: map(),
  object: term(),
  output: term(),
  status: term(),
  stop_reason: term()
}

Terminal result of a provider CLI run.

:object carries a provider-returned structured object when the run requested one and the provider actually returned it. It stays nil otherwise; nothing here reconstructs or guesses an object from prose.

Functions

new(attrs \\ [])

@spec new(keyword() | map() | struct()) :: struct()

parse(payload)

@spec parse(keyword() | map() | struct()) ::
  {:ok, struct()}
  | {:error,
     {:invalid_payload, module(), CliSubprocessCore.Schema.error_detail()}}

parse!(payload)

@spec parse!(keyword() | map() | struct()) :: struct()

schema()

@spec schema() :: Zoi.schema()

to_map(payload)

@spec to_map(struct()) :: map()