Exosphere.Community.App.Defs.LexiconInterop (Exosphere v0.6.0)

Copy Markdown View Source

Self-declared AT Protocol lexicon interoperability signals.

Object schema community.lexicon.app.defs##lexiconInterop.

Fields

  • consumes: Lexicon collections this app reads, displays, imports, or otherwise consumes.
  • produces: Lexicon collections this app creates or publishes records for.

Summary

Functions

Decode a wire-format map. Delegates to new/1.

Build and validate from a map of attrs (atom or wire string keys).

Build and validate, raising ArgumentError on error.

Encode to the wire-format map.

The lexicon type ID (nsid or nsid#def) this module was generated from.

Types

t()

@type t() :: %Exosphere.Community.App.Defs.LexiconInterop{
  consumes: [String.t()] | nil,
  extra: term(),
  produces: [String.t()] | nil
}

Functions

from_map(map)

@spec from_map(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Decode a wire-format map. Delegates to new/1.

new(attrs)

@spec new(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Build and validate from a map of attrs (atom or wire string keys).

Unknown keys are kept in extra and re-emitted by to_map/1.

new!(attrs)

@spec new!(map()) :: t()

Build and validate, raising ArgumentError on error.

to_map(struct)

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

Encode to the wire-format map.

type_id()

@spec type_id() :: String.t()

The lexicon type ID (nsid or nsid#def) this module was generated from.