Terrasol.Document.ES4 (Terrasol v2.0.2)

View Source

Handling of the Earthstar "es.4" document format and the resulting structures

Summary

Functions

Build a Terrasol.Document.ES4 from a map containing all or some of the required keys.

Parse and return a Terrasol.Document.ES4 from a map.

Functions

build(map)

Build a Terrasol.Document.ES4 from a map containing all or some of the required keys.

This is resolved internally in a deterministic way which is implementation-specific and should not be depended upon to remain the same between versions.

A :ttl key may be used. It will be parsed into a :deleteAfter using the document timestamp and adding Terrasol.duration_us(ttl)

The final value is passed through parse/1 returning as that function does.

parse(document)

Parse and return a Terrasol.Document.ES4 from a map.

Returns {:invalid, [error_field]} on an invalid document