Dsxir.Signature.Field (dsxir v0.1.0)

Copy Markdown

Internal struct produced by the Signature DSL for each input / output entity.

:type holds the raw user value (shorthand atom, tuple, or Zoi schema). :zoi is populated by the transformer with the canonical Zoi schema. :kind is :input or :output.

Summary

Types

kind()

@type kind() :: :input | :output

t()

@type t() :: %Dsxir.Signature.Field{
  __spark_metadata__: term(),
  desc: nil | String.t(),
  kind: kind(),
  name: atom(),
  type: term(),
  zoi: nil | Zoi.schema()
}