red

v0.2.0

red v0.2.0 Red.Entity

Provides the representation of an entity.

The focus of Red is to persist relations between entities, but not entities’ data per se.

Therefore, the representation of an entity is focused on its unique identification. A %Red.Entity{id, class} needs to have a id, and optionally have a class.

The function build/1 provides an extensive way to build entity structs.

Link to this section Summary

Types

class_t()
conversible_to_entity()
id_t()
t()

Functions

build(entity)

See Red.entity/1 for examples

Link to this section Types

Link to this type class_t() 
class_t() :: atom | String.t
Link to this type conversible_to_entity() 
conversible_to_entity ::
  t |
  String.t |
  id_t |
  {class_t, id_t} |
  [{class_t, id_t}, ...]
Link to this type id_t() 
id_t() :: integer | atom | String.t
Link to this type t() 
t() :: %Red.Entity{class: class_t, id: id_t}

Link to this section Functions

Link to this function build(entity) 
build(conversible_to_entity) :: t

See Red.entity/1 for examples