Dsxir.Signature.Runtime (dsxir v0.1.0)

Stable introspection surface for signature modules. Callers depend on this module rather than on the Spark Info generator output.

Summary

signature()

Return all declared fields for the signature, in source order.

Return the input fields for the signature.

Return the user-supplied instruction string, or nil if none was set.

Return the output fields for the signature.

Look up the Zoi schema for the field named name.

@type signature() :: module() | Dsxir.Signature.Compiled.t()

@spec fields(signature()) :: [Dsxir.Signature.Field.t()]

Return all declared fields for the signature, in source order.

@spec inputs(signature()) :: [Dsxir.Signature.Field.t()]

Return the input fields for the signature.

@spec instruction(signature()) :: nil | String.t()

Return the user-supplied instruction string, or nil if none was set.

@spec outputs(signature()) :: [Dsxir.Signature.Field.t()]

Return the output fields for the signature.

@spec zoi_for(signature(), atom()) :: {:ok, Zoi.schema()} | :error

Look up the Zoi schema for the field named name.