CliSubprocessCore.Payload.Raw (CliSubprocessCore v0.1.0)

Copy Markdown View Source

Represents an unnormalized raw provider payload.

Summary

Types

stream()
t()

Functions

new(attrs \\ [])
parse(payload)
parse!(payload)
schema()
to_map(payload)

Types

stream()

@type stream() :: :stdout | :stderr | atom() | String.t()

t()

@type t() :: %CliSubprocessCore.Payload.Raw{
  content: term(),
  extra: map(),
  metadata: map(),
  stream: stream()
}

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()