ExKcal.Products (ExKcal v0.0.8)

Main purpose of the module is to represent set of products and primitives required to manipulate it. It's analog of MapSet, but MapSet leaves us in uneasy situation, as its implementation details are private (opaque type) so there is no clean way of using it in guards (without (ab)using knowledge of hidden implementation details), and there are very few primitives accompanying it. ExKcal.Products offers something similar, doesn't hide implementation details, and builds upon them.

Link to this section Summary

Types

t()

Functions

add(products, product)

Add Product to Products.

find(regex, products, fields \\ [:name, :description])

Find Products by any field.

from_list(list)

Products from list of Products.

get(products, name)

Get Product by content of the name field. Exact match is required.

new()

Get new instance of Products struct. Equivalent of %Products{map: %{}}.

Link to this section Types

t()

Specs

t() :: %ExKcal.Products{map: %{required(ExKcal.Product.t()) => nil}}

Link to this section Functions

add(products, product)

Specs

add(t(), ExKcal.Product.t()) :: {:ok, t()} | {:noop, :already_member}

Add Product to Products.

find(regex, products, fields \\ [:name, :description])

Specs

find(Regex.t(), t(), list()) :: {:ok, list()} | {:not_found, nil}

Find Products by any field.

Notes

Match is done against space-separated, merged list of requested fields. This means that there is only one end of line, not multiple like in case of multiple, separate fields.

from_list(list)

Specs

from_list([ExKcal.Product.t()]) :: t()

Products from list of Products.

get(products, name)

Specs

get(t(), String.t()) :: {:ok, ExKcal.Product.t()} | {:not_found, nil}

Get Product by content of the name field. Exact match is required.

new()

Specs

new() :: t()

Get new instance of Products struct. Equivalent of %Products{map: %{}}.