RDF.Serialization.Decoder behaviour (RDF.ex v0.9.4) View Source

A behaviour for decoders of strings encoded in a specific RDF.Serialization format.

Link to this section Summary

Callbacks

Decodes a serialized RDF.Graph or RDF.Dataset from a string.

Decodes a serialized RDF.Graph or RDF.Dataset from a string.

Decodes a serialized RDF.Graph or RDF.Dataset from a stream.

Decodes a serialized RDF.Graph or RDF.Dataset from a stream.

Link to this section Callbacks

Specs

decode(String.t(), keyword()) ::
  {:ok, RDF.Graph.t() | RDF.Dataset.t()} | {:error, any()}

Decodes a serialized RDF.Graph or RDF.Dataset from a string.

It returns an {:ok, data} tuple, with data being the deserialized graph or dataset, or {:error, reason} if an error occurs.

Specs

decode!(String.t(), keyword()) :: RDF.Graph.t() | RDF.Dataset.t()

Decodes a serialized RDF.Graph or RDF.Dataset from a string.

As opposed to decode/2, it raises an exception if an error occurs.

Note: The __using__ macro automatically provides an overridable default implementation based on the non-bang decode function.

Link to this callback

decode_from_stream(arg1, keyword)

View Source (optional)

Specs

decode_from_stream(Enumerable.t(), keyword()) ::
  {:ok, RDF.Graph.t() | RDF.Dataset.t()} | {:error, any()}

Decodes a serialized RDF.Graph or RDF.Dataset from a stream.

It returns an {:ok, data} tuple, with data being the deserialized graph or dataset, or {:error, reason} if an error occurs.

Link to this callback

decode_from_stream!(arg1, keyword)

View Source (optional)

Specs

decode_from_stream!(Enumerable.t(), keyword()) ::
  RDF.Graph.t() | RDF.Dataset.t()

Decodes a serialized RDF.Graph or RDF.Dataset from a stream.

As opposed to decode_from_stream/2, it raises an exception if an error occurs.

Note: The __using__ macro automatically provides an overridable default implementation based on the non-bang decode function.