Arcana.DocumentMetadata (Arcana v4.0.0)

Copy Markdown View Source

Sparse document attribution returned by Arcana.get_document_metadata/2.

This shape deliberately leaves out document content, ingestion state, and associations. Use to_map/1 when passing it to an encoder or another API.

Summary

Types

t()

Functions

to_map(document)

Returns the documented plain-map representation of the metadata projection.

Types

t()

@type t() :: %Arcana.DocumentMetadata{
  id: Ecto.UUID.t(),
  metadata: map(),
  source_id: String.t() | nil
}

Functions

to_map(document)

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

Returns the documented plain-map representation of the metadata projection.