entity

Types

Entity

pub type Entity {
  Entity(
    metadata: metadata.ModelMetadata,
    fields: List(unit_of_work.FieldValue),
    loaded_relations: List(String),
    status: EntityStatus,
  )
}

Constructors

Entity(
  metadata: metadata.ModelMetadata,
  fields: List(unit_of_work.FieldValue),
  loaded_relations: List(String),
  status: EntityStatus,
)

EntityError

</>

pub type EntityError {
  UnknownColumn(table: relation.TableRef, column: String)
  UnknownRelation(
    table: relation.TableRef,
    relation_name: String,
  )
  MissingIdentityField(table: relation.TableRef, column: String)
  DeletedEntity(relation.TableRef)
}

Constructors

UnknownColumn(table: relation.TableRef, column: String)

UnknownRelation(table: relation.TableRef, relation_name: String)

MissingIdentityField(table: relation.TableRef, column: String)

```
DeletedEntity(relation.TableRef)
```

EntityStatus

</>

pub type EntityStatus {
  Clean
  New
  Dirty(changes: List(unit_of_work.FieldValue))
  Deleted
}

Constructors

```
Clean
```
```
New
```

Dirty(changes: List(unit_of_work.FieldValue))

```
Deleted
```

Values

change

</>

pub fn change(
  entity: Entity,
  changes: List(unit_of_work.FieldValue),
) -> Result(Entity, EntityError)

fields

</>

pub fn fields(entity: Entity) -> List(unit_of_work.FieldValue)

identity

</>

pub fn identity(
  entity: Entity,
) -> Result(unit_of_work.Identity, EntityError)

mark_clean

</>

pub fn mark_clean(entity: Entity) -> Entity

mark_deleted

</>

pub fn mark_deleted(entity: Entity) -> Entity

mark_relation_loaded

</>

pub fn mark_relation_loaded(
  entity: Entity,
  relation_name: String,
) -> Result(Entity, EntityError)

materialize

</>

pub fn materialize(
  metadata: metadata.ModelMetadata,
  fields: List(unit_of_work.FieldValue),
) -> Result(Entity, EntityError)

new_

</>

pub fn new_(
  metadata: metadata.ModelMetadata,
  fields: List(unit_of_work.FieldValue),
) -> Result(Entity, EntityError)

relation_loaded

</>

pub fn relation_loaded(
  entity: Entity,
  relation_name: String,
) -> Bool

stage

</>

pub fn stage(
  session: unit_of_work.Session,
  entity: Entity,
) -> Result(unit_of_work.Session, EntityError)

status

</>

pub fn status(entity: Entity) -> EntityStatus