View Source DataSpecs.Cast.Builtin (dataspecs v2.1.0)
Erlang builtin types cast.
Summary
Types
@type map_field_res() :: {:error, DataSpecs.Types.reason()} | {:ok, {map(), map(), DataSpecs.Types.reason()}}
Functions
@spec any(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, any()}
@spec arity(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, arity()}
@spec atom(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, atom()}
@spec binary(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, binary()}
@spec binary( DataSpecs.Types.value(), integer(), integer(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ] ) :: {:error, DataSpecs.Types.reason()} | {:ok, binary()}
@spec bitstring(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, bitstring()}
@spec boolean(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, boolean()}
@spec byte(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, byte()}
@spec char(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, char()}
@spec empty_list(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, []}
@spec empty_map(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, %{}}
@spec float(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, float()}
@spec integer(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, integer()}
@spec list(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, list()}
@spec map_field_optional(map(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: map_field_res()
@spec map_field_required(map(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: map_field_res()
@spec neg_integer(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, neg_integer()}
@spec non_neg_integer(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, non_neg_integer()}
@spec nonempty_list(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, [...]}
@spec number(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, number()}
@spec pid(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, pid()}
@spec pos_integer(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, pos_integer()}
@spec range( integer(), integer(), DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ] ) :: {:error, DataSpecs.Types.reason()} | {:ok, integer()}
@spec reference(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, reference()}
@spec tuple(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, tuple()}
@spec tuple_any(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, tuple()}
@spec union(DataSpecs.Types.value(), DataSpecs.Types.custom_type_casts(), [ DataSpecs.Types.type_cast_fun() ]) :: {:error, DataSpecs.Types.reason()} | {:ok, any()}