Haystack

View Source Haystack.Index.Attr behaviour (Haystack v0.1.0)

A behaviour for defining a store attr.

Link to this section Summary

Types

opts()

Callbacks

delete(t, t, opts)

Delete an attr.

insert(t, t, opts)

Insert an attr.

key(opts)

The attr key.

Functions

default()

Return the default attrs.

Link to this section Types

Link to this type

opts()

View Source 
@type opts() :: Keyword.t()

Link to this section Callbacks

Link to this callback

delete(t, t, opts)

View Source 
@callback delete(Haystack.Index.t(), Haystack.Index.Document.t(), opts()) ::
  Haystack.Index.t()

Delete an attr.

Link to this callback

insert(t, t, opts)

View Source 
@callback insert(Haystack.Index.t(), Haystack.Index.Document.t(), opts()) ::
  Haystack.Index.t()

Insert an attr.

Link to this callback

key(opts)

View Source 
@callback key(opts()) :: tuple()

The attr key.

Link to this section Functions

Link to this function

default()

View Source 
@spec default() :: %{
  insert: [{module(), Keyword.t()}],
  delete: [{module(), Keyword.t()}]
}

Return the default attrs.