Codex.Protocol.Plugin.Source (Codex SDK v0.16.1)

Copy Markdown View Source

Plugin source metadata returned by the app-server plugin APIs.

Summary

Types

source_type()
t()

Functions

from_map(data)
parse(value)
parse!(value)
schema()
to_map(value)

Types

source_type()

@type source_type() :: :local | String.t()

t()

@type t() :: %Codex.Protocol.Plugin.Source{
  extra: map(),
  path: (String.t() | nil) | nil,
  type: source_type()
}

Functions

from_map(data)

@spec from_map(map() | keyword() | t()) :: t()

parse(value)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error, {:invalid_plugin_source, CliSubprocessCore.Schema.error_detail()}}

parse!(value)

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

schema()

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

to_map(value)

@spec to_map(t()) :: map()