RDF.NQuads (RDF.ex v0.9.1) View Source

RDF.NQuads provides support for the N-Quads serialization format.

N-Quads is a line-based plain-text format for encoding an RDF dataset, i.e. a collection of RDF graphs.

An example of an RDF statement in N-Quads format:

<https://hex.pm/> <http://purl.org/dc/terms/title> "Hex" <http://example.org/graphs/example> .

see https://www.w3.org/TR/n-quads/

Link to this section Summary

Functions

Deserializes a graph or dataset from a file.

Deserializes a graph or dataset from a file.

Deserializes a graph or dataset from a stream.

Deserializes a graph or dataset from a stream.

Deserializes a graph or dataset from a string.

Deserializes a graph or dataset from a string.

Serializes a RDF data structure to a file.

Serializes a RDF data structure to a file.

Serializes a RDF data structure to a stream.

Serializes a RDF data structure to a string.

Serializes a RDF data structure to a string.

Link to this section Functions

Link to this function

read_file(file, opts \\ [])

View Source

Specs

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

Deserializes a graph or dataset from a file.

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

Options

General serialization-independent options:

  • :stream: Allows to enable reading the data from a file directly via a stream (default: false on this function, true on the bang version)
  • :gzip: Allows to read directly from a gzipped file (default: false)
  • :file_mode: A list with the Elixir File.open modes to be used for reading (default: [:read, :utf8])

See the module documentation of the decoder for the available format-specific options, all of which can be used in this function and will be passed them through to the decoder.

Link to this function

read_file!(file, opts \\ [])

View Source

Specs

read_file!(Path.t(), keyword()) :: RDF.Graph.t() | RDF.Dataset.t()

Deserializes a graph or dataset from a file.

As opposed to read_file/2, it raises an exception if an error occurs and defaults to stream: true.

See read_file/3 for the available format-independent options.

See the module documentation of the decoder for the available format-specific options, all of which can be used in this function and will be passed them through to the decoder.

Link to this function

read_stream(stream, opts \\ [])

View Source

Specs

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

Deserializes a graph or 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.

See the module documentation of the decoder for the available format-specific options, all of which can be used in this function and will be passed them through to the decoder.

Link to this function

read_stream!(stream, opts \\ [])

View Source

Specs

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

Deserializes a graph or dataset from a stream.

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

See the module documentation of the decoder for the available format-specific options, all of which can be used in this function and will be passed them through to the decoder.

Link to this function

read_string(content, opts \\ [])

View Source

Specs

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

Deserializes a graph or 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.

See the module documentation of the decoder for the available format-specific options, all of which can be used in this function and will be passed them through to the decoder.

Link to this function

read_string!(content, opts \\ [])

View Source

Specs

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

Deserializes a graph or dataset from a string.

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

See the module documentation of the decoder for the available format-specific options, all of which can be used in this function and will be passed them through to the decoder.

Link to this function

write_file(data, path, opts \\ [])

View Source

Specs

write_file(RDF.Data.t(), Path.t(), keyword()) :: :ok | {:error, any()}

Serializes a RDF data structure to a file.

It returns :ok if successful or {:error, reason} if an error occurs.

Options

General serialization-independent options:

  • :stream: Allows to enable writing the serialized data to the file directly via a stream. Possible values: :string or :iodata for writing to the file with a stream of strings respective IO lists, true if you want to use streams, but don't care for the exact method or false for not writing with a stream (default: false on this function, :iodata on the bang version)
  • :gzip: Allows to write directly to a gzipped file (default: false)
  • :force: If not set to true, an error is raised when the given file already exists (default: false)
  • :file_mode: A list with the Elixir File.open modes to be used for writing (default: [:write, :exclusive])

See the module documentation of the encoder for the available format-specific options, all of which can be used in this function and will be passed them through to the encoder.

Link to this function

write_file!(data, path, opts \\ [])

View Source

Specs

write_file!(RDF.Data.t(), Path.t(), keyword()) :: :ok

Serializes a RDF data structure to a file.

As opposed to write_file/3, it raises an exception if an error occurs.

See write_file/3 for the available format-independent options.

See the module documentation of the encoder for the available format-specific options, all of which can be used in this function and will be passed them through to the encoder.

Link to this function

write_stream(data, opts \\ [])

View Source

Specs

write_stream(RDF.Data.t(), keyword()) :: Enumerable.t()

Serializes a RDF data structure to a stream.

See the module documentation of the encoder for the available format-specific options, all of which can be used in this function and will be passed them through to the encoder.

Link to this function

write_string(data, opts \\ [])

View Source

Specs

write_string(RDF.Data.t(), keyword()) :: {:ok, String.t()} | {:error, any()}

Serializes a RDF data structure to a string.

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

See the module documentation of the encoder for the available format-specific options, all of which can be used in this function and will be passed them through to the encoder.

Link to this function

write_string!(data, opts \\ [])

View Source

Specs

write_string!(RDF.Data.t(), keyword()) :: String.t()

Serializes a RDF data structure to a string.

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

See the module documentation of the encoder for the available format-specific options, all of which can be used in this function and will be passed them through to the encoder.