ExecutionPlane.Lane.Capabilities (execution_plane v0.1.0)

Copy Markdown View Source

Lane adapter capability descriptor.

Summary

Types

t()

Functions

dump(value)
from_json!(json)
load(attrs)
load!(attrs)
new(value)
new!(attrs \\ %{})
to_json!(value)

Types

t()

@type t() :: %ExecutionPlane.Lane.Capabilities{
  contract_version: term(),
  lane_id: term(),
  metadata: term(),
  protocols: term(),
  supports_execute: term(),
  supports_stream: term(),
  surfaces: term()
}

Functions

dump(value)

@spec dump(struct()) :: map()

from_json!(json)

@spec from_json!(String.t()) :: struct()

load(attrs)

@spec load(map() | keyword() | struct()) :: {:ok, struct()} | {:error, Exception.t()}

load!(attrs)

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

new(value)

@spec new(map() | keyword() | struct()) :: {:ok, struct()} | {:error, Exception.t()}

new!(attrs \\ %{})

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

to_json!(value)

@spec to_json!(struct()) :: String.t()