View Source Terrasol.Document (Terrasol v2.0.1)

Generic document handling

One may add additional handlers which conform to the Terrasol.Document.Format behaviour. These are controlled by Config parameters. The default values are equivalent to:

config :terrasol,
  load_default_format_mods: true,
  format_mods: []

Summary

Functions

build(doc)

Build a Terrasol.Document from a supplied map applying appropriate defaults

parse(doc)

Parse a map into a Terrasol.Document struct

Functions

Link to this function

build(doc)

View Source

Build a Terrasol.Document from a supplied map applying appropriate defaults

Defaults to "es.4" format.

Returns :error on an unparseable map. tuple if a Terrasol.Document.Format handler returns same. Returns an :invalid tuple if a Terrasol.Document.Format handler returns same.

Link to this function

parse(doc)

View Source

Parse a map into a Terrasol.Document struct

This consists of:

format: the selected module content: an appropriate struct

Strings are considered to be JSON maps and decoded before use.

Returns :error on an unparseable map. tuple if a Terrasol.Document.Format handler returns same. Returns an :invalid tuple if a Terrasol.Document.Format handler returns same.