NLdoc.Spec.Event.Progress (NLdoc.Spec.Event v1.0.15)

View Source

This module defines the Ecto schema for the NLdoc Event 'progress'.

Summary

Types

t()

Functions

changeset(object, attrs)
new(template)

This function creates a new NLdoc.Spec.Event.Progress struct from a map of keys and values, where the keys are snake_case. Returns a tuple with either {:ok, progress} or {:error, changeset}.

resource_type()

Types

t()

@type t() :: %NLdoc.Spec.Event.Progress{
  context: NLdoc.Spec.Event.Progress.Context.t(),
  timestamp: DateTime.t(),
  trace_id: String.t(),
  type: String.t()
}

Functions

changeset(object, attrs)

@spec changeset(
  struct(),
  map()
) :: Ecto.Changeset.t()

new(template)

@spec new(map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

This function creates a new NLdoc.Spec.Event.Progress struct from a map of keys and values, where the keys are snake_case. Returns a tuple with either {:ok, progress} or {:error, changeset}.

Note: If you want to use a map with camelCase keys, use NLdoc.Util.Recase.to_snake/1 to convert them to snake_case before passing them to the constructor.

resource_type()