Decree.PersonalFields.Declaration (decree v0.1.0)

Copy Markdown View Source

What an event declares through Decree.Event.PersonalFields.

  • fields - the personal fields of the event, each with its subject.

  • metadata - the personal metadata entries, each with its subject.

  • retired_fields - the retired fields of the event, by name.

  • retired_metadata - the retired metadata entries, by name.

A subject is one of :x, {:first_present, [:a, :b]} or {:when_present, :x}. A retired name has none: a stored envelope names its own subject, and a retired slot never encrypts.

Summary

Types

subject()

@type subject() :: atom() | {:first_present, [atom(), ...]} | {:when_present, atom()}

t()

@type t() :: %Decree.PersonalFields.Declaration{
  fields: [{atom(), subject()}],
  metadata: [{atom(), subject()}],
  retired_fields: [atom()],
  retired_metadata: [atom()]
}