vdev

vdev Knot.Repo.Type.Height

Link to this section Summary

Functions

cast(val)

Casts the given input to the custom type

dump(val)

Dumps the given term into an Ecto native type

load(val)

Loads the given term into a custom type

type()

Returns the underlying schema type for the custom type

Link to this section Functions

Link to this function cast(val) 
cast(Knot.Block.height) :: {:ok, integer}

Casts the given input to the custom type.

This callback is called on external input and can return any type, as long as the dump/1 function is able to convert the returned value back into an Ecto native type. There are two situations where this callback is called:

  1. When casting values by Ecto.Changeset
  2. When passing arguments to Ecto.Query

Callback implementation for Ecto.Type.cast/1.

Link to this function dump(val) 
dump(Knot.Block.height) :: {:ok, integer}

Dumps the given term into an Ecto native type.

This callback is called with any term that was stored in the struct and it needs to validate them and convert it to an Ecto native type.

Callback implementation for Ecto.Type.dump/1.

Link to this function load(val) 
load(integer) :: {:ok, Knot.Block.height}

Loads the given term into a custom type.

This callback is called when loading data from the database and receive an Ecto native type. It can return any type, as long as the dump/1 function is able to convert the returned value back into an Ecto native type.

Callback implementation for Ecto.Type.load/1.

Link to this function type() 
type() :: :integer

Returns the underlying schema type for the custom type.

For example, if you want to provide your own date structures, the type function should return :date.

Note this function is not required to return Ecto primitive types, the type is only required to be known by the adapter.

Callback implementation for Ecto.Type.type/0.