View Source RDF.NQuads.Encoder (RDF.ex v2.0.1)
An encoder for N-Quads serializations of RDF.ex data structures.
As for all encoders of RDF.Serialization.Format
s, you normally won't use these
functions directly, but via one of the write_
functions on the RDF.NQuads
format module or the generic RDF.Serialization
module.
Options
:default_graph_name
: The graph name to be used as the default for triples from aRDF.Graph
orRDF.Description
. When the input to be encoded is aRDF.Description
the default isnil
for the default graph. In case of aRDF.Graph
the default is theRDF.Graph.name/1
. The option doesn't have any effect at all when the input to be encoded is aRDF.Dataset
.:sort
: Boolean flag which specifies if the encoded statements should be sorted into Unicode code point order (default:false
). This option is available only onencode/2
.:mode
: Allows to specify if the encoded statements should be emitted as strings or IO lists using the value:string
or:iodata
respectively (default::string
). This option is available only onstream/2
.
Summary
Functions
Encodes the given RDF data in N-Quads format.
Encodes the given RDF data into a stream of N-Quads.
Functions
@spec encode( RDF.Data.t(), keyword() ) :: {:ok, String.t()} | {:error, any()}
Encodes the given RDF data in N-Quads format.
See module documentation for available options.
@spec iolist_statement(RDF.Statement.t(), RDF.Statement.graph_name()) :: iolist()
@spec statement(RDF.Statement.t(), RDF.Statement.graph_name()) :: String.t()
@spec stream( RDF.Data.t(), keyword() ) :: Enumerable.t()
Encodes the given RDF data into a stream of N-Quads.
See module documentation for available options.