API Reference NoizuLabs Entities v#0.2.1

Modules

Noizu Entities are Structs with meta data for permissions, json encoding, persistence channels, cache and more.

Load def_entity context.

ACL protocol is used to strip/removed fields context user does not have access to.

A derived field is a field that is calculated from other fields on load.

Helper functions for derived fields.

Field that is encoded on ecto using uuid and type fields.

Defines Entity.Field behavior used for marshalling from/to peristence layers and managing complex/compound types that compose/break fields up into layer specific fields.

Define the Noizu.Entity.Json.Protocol used for preparing format style json responses. TODO https://github.com/noizu-labs-scaffolding/entities/issues/2

This module provides macros for defining entities and their fields.

This module provides macros for defining access control lists (ACLs) for entities and fields.

Macros for annotating json settings on entity fields.

Module for checking and encoding entity metadata.

Meta Data Record for ACL settings.

Logic for atom id backed entities.

This module provides methods for generating and parsing identifiers for entities with dual references.

Meta Data Record for Field Settings.

Logic for entity identifier details.

Logic for entities that use an integer value for their id.

Logic for entity json details.

Persistence Settings Metadata Record.

Logic for entities that use a ref value for their id.

Logic for UUID id backed entities.

Default implementation of UUIDIdentifier backed entities.

Entity field for encoding path data.

Unique Identifier for Persistence Layer

A entity field type that is persisted as a ref/id of another field.

Use for declaring a field reference to handle encoding/decoding when writting to storage.

This is the protocol used to pack/unpack individual fields (if the fields have a type implementation.) to and from storage.

Protocol used to save/load entities from store. Leverage Entity.FieldProtocol to pack/unpack individual fields.

Support for Ecto backed Entities.

Support for Redis backed Entities.

TimeStamp custom field. This field is used to track inserted_at, updated_at, and deleted_at timestamp.

Wrapper around UUID generator: to allow custom uuid generator logic.

A entity type that converted entities to and from uuids/refs for persistence.

Define Entity Repo Crud Behaviour.

Load def_repo context.

Macros for setting up Entity Repos.

Logic for driving entity repos.

Wrapper around UUID provider.

Helper utilities for entities.

Mix Tasks

mix nz.gen.entity Repo Entity schema --sref=reference --store=ecto --id=uuid --field=field_name:type use --no-live to prevent live view generation use --no-ecto to prevent context and entity generation