exhal v4.6.0 ExHal.Document
A document is the representaion of a single resource in HAL.
Summary
Functions
Returns a new %ExHal.Document
representing the HAL document provided
Fetches value of specified property or links whose rel
matches
Returns new ExHal.Document
Returns the link or property of the specified name, or default
if
neither or found
Returns link or property of the specified name, or the result of default_fun
if neither are found
Returns [%Link{}...]
when link exists or result of default
otherwise
Returns [%Link{}...]
when link exists or result of default_fun
otherwise
Returns property value when property exists or default
otherwise
Returns <property value>
when property exists or result of default_fun
otherwise
Returns true iff the document contains at least one link with the specified rel
Returns a new %ExHal.Document
representing the HAL document provided
Add a link to a Document
Add or update a property to a Document
Returns a string representation of this HAL document
Deprecated
Returns {:ok, <url of specified document>}
or :error
Functions
Fetches value of specified property or links whose rel
matches
Returns {:ok, <property value>}
if name
identifies a property;
`{:ok, [%Link{}, ...]}` if `name` identifies a link;
`:error` othewise
Returns the link or property of the specified name, or default
if
neither or found.
Returns link or property of the specified name, or the result of default_fun
if neither are found.
Returns [%Link{}...]
when link exists or result of default
otherwise.
Returns [%Link{}...]
when link exists or result of default_fun
otherwise.
Returns property value when property exists or default
otherwise
Returns <property value>
when property exists or result of default_fun
otherwise
Returns true iff the document contains at least one link with the specified rel.
Returns a new %ExHal.Document
representing the HAL document provided.
Add a link to a Document.
Returns new ExHal.Document with the specified link.
Add or update a property to a Document.
Returns new ExHal.Document with the specified property set to the specified value.