API Reference croma v0.12.0

View Source

Modules

Utility module to import croma macros.

Module that represents any Elixir term.

Module that represents the Elixir's built-in atom type. Intended to be used with other parts of croma to express atom variables.

Module that represents the Elixir's built-in binary type. Intended to be used with other parts of croma to express binary variables.

Module that represents the Elixir's built-in bitstring type. Intended to be used with other parts of croma to express bitstring variables.

Module that represents the Elixir's built-in boolean type. Intended to be used with other parts of croma to express boolean variables.

Module that represents the Elixir's built-in byte type. Intended to be used with other parts of croma to express byte variables.

Module that represents the Elixir's built-in char type. Intended to be used with other parts of croma to express char variables.

Module that provides Croma.Defpt.defpt/2 macro.

Module that provides Croma.Defun.defun/2 macro.

Module that represents the Elixir's built-in float type. Intended to be used with other parts of croma to express float variables.

Module that represents the Elixir's built-in function type. Intended to be used with other parts of croma to express function variables.

Module to work with guard generation (see Croma.Defun.defun/2). This module is intended for internal use.

Module that represents the Elixir's built-in integer type. Intended to be used with other parts of croma to express integer variables.

Module that represents the Elixir's built-in list type. Intended to be used with other parts of croma to express list variables.

Implementation of Croma.Monad interface for built-in lists.

Module that represents the Elixir's built-in map type. Intended to be used with other parts of croma to express map variables.

This module defines an interface for monad.

Module that represents the Elixir's built-in neg_integer type. Intended to be used with other parts of croma to express neg_integer variables.

Module that represents the Elixir's built-in non_neg_integer type. Intended to be used with other parts of croma to express non_neg_integer variables.

Module that represents the Elixir's built-in number type. Intended to be used with other parts of croma to express number variables.

Module that represents the Elixir's built-in pid type. Intended to be used with other parts of croma to express pid variables.

Module that represents the Elixir's built-in port type. Intended to be used with other parts of croma to express port variables.

Module that represents the Elixir's built-in pos_integer type. Intended to be used with other parts of croma to express pos_integer variables.

Module that represents the Elixir's built-in reference type. Intended to be used with other parts of croma to express reference variables.

A simple data structure to represent a result of computation that can either succeed or fail, in the form of {:ok, any} or {:error, any}.

Module that represents the Elixir's built-in String.t type. Intended to be used with other parts of croma to express String.t variables.

Module to define structs with validation and conversion functions, based on its type information.

Helper module to define type whose members are a fixed set of atoms. The following members are generated by use Croma.SubtypeOfAtom

Helper module to define float-based types. The following members are generated by use Croma.SubtypeOfFloat

Helper module to define float-based types. The following members are generated by use Croma.SubtypeOfFloatWithConversionFromInt

Helper module to define integer-based types. The following members are generated by use Croma.SubtypeOfInt

Helper module to define list-based types. The following members are generated by use Croma.SubtypeOfList

Helper module to define map-based types. The following members are generated by use Croma.SubtypeOfMap

Helper module to define number-based (integer or float) types. The following members are generated by use Croma.SubtypeOfNumber

Helper module to define string-based types. The following members are generated by use Croma.SubtypeOfString

Helper module to define tuple-based types. The following members are generated by use Croma.SubtypeOfTuple

Module to be used by test modules to make tests a bit shorter.

Module that represents the Elixir's built-in tuple type. Intended to be used with other parts of croma to express tuple variables.

Module that defines macros for ad-hoc (in other words "in-line") module definitions.

Utilities to work with internal representation of types.

Module for code generation of argument validation (see Croma.Defun.defun/2). This module is intended for internal use.

Mix Tasks

Custom compiler that checks if Croma consistently defines new/1 functions.