Topics
	String Utilities
	Byte Streams
	URI
	Node
	Event Handlers
	Environment
	Reader
	Writer

Classes
struct	SerdNode
	A syntactic RDF node. More...
struct	SerdChunk
	An unterminated string fragment. More...
struct	SerdError
	An error description. More...
struct	SerdURI

Typedefs
typedef struct SerdEnvImpl	SerdEnv
	Lexical environment for relative URIs or CURIEs (base URI and namespaces).
typedef struct SerdReaderImpl	SerdReader
	Streaming parser that reads a text stream and writes to a statement sink.
typedef struct SerdWriterImpl	SerdWriter
	Streaming serialiser that writes a text stream as statements are pushed.
typedef uint32_t	SerdStatementFlags
	Bitwise OR of SerdStatementFlag values.
typedef uint32_t	SerdNodeFlags
	Bitwise OR of SerdNodeFlag values.
typedef struct SerdEnvImpl	SerdEnv
typedef struct SerdReaderImpl	SerdReader
typedef struct SerdWriterImpl	SerdWriter
typedef uint32_t	SerdStatementFlags
typedef uint32_t	SerdNodeFlags

Enumerations
enum	SerdStatus { SERD_SUCCESS , SERD_FAILURE , SERD_ERR_UNKNOWN , SERD_ERR_BAD_SYNTAX , SERD_ERR_BAD_ARG , SERD_ERR_NOT_FOUND , SERD_ERR_ID_CLASH , SERD_ERR_BAD_CURIE , SERD_ERR_INTERNAL }
	Return status code. More...
enum	SerdSyntax { SERD_TURTLE = 1 , SERD_NTRIPLES = 2 , SERD_NQUADS = 3 , SERD_TRIG = 4 }
	RDF syntax type. More...
enum	SerdStatementFlag { SERD_EMPTY_S = 1u << 1u , SERD_EMPTY_O = 1u << 2u , SERD_ANON_S_BEGIN = 1u << 3u , SERD_ANON_O_BEGIN = 1u << 4u , SERD_ANON_CONT = 1u << 5u , SERD_LIST_S_BEGIN = 1u << 6u , SERD_LIST_O_BEGIN = 1u << 7u , SERD_LIST_CONT = 1u << 8u }
	Flags indicating inline abbreviation information for a statement. More...
enum	SerdType { SERD_NOTHING = 0 , SERD_LITERAL = 1 , SERD_URI = 2 , SERD_CURIE = 3 , SERD_BLANK = 4 }
enum	SerdNodeFlag { SERD_HAS_NEWLINE = 1u << 0u , SERD_HAS_QUOTE = 1u << 1u }
	Flags indicating certain string properties relevant to serialisation. More...
enum	SerdStyle { SERD_STYLE_ABBREVIATED = 1u << 0u , SERD_STYLE_ASCII = 1u << 1u , SERD_STYLE_RESOLVED = 1u << 2u , SERD_STYLE_CURIED = 1u << 3u , SERD_STYLE_BULK = 1u << 4u }
enum	SerdStatus { SERD_SUCCESS , SERD_FAILURE , SERD_ERR_UNKNOWN , SERD_ERR_BAD_SYNTAX , SERD_ERR_BAD_ARG , SERD_ERR_NOT_FOUND , SERD_ERR_ID_CLASH , SERD_ERR_BAD_CURIE , SERD_ERR_INTERNAL }
enum	SerdSyntax { SERD_TURTLE = 1 , SERD_NTRIPLES = 2 }
enum	SerdStatementFlag { SERD_EMPTY_S = 1 << 1 , SERD_EMPTY_O = 1 << 2 , SERD_ANON_S_BEGIN = 1 << 3 , SERD_ANON_O_BEGIN = 1 << 4 , SERD_ANON_CONT = 1 << 5 , SERD_LIST_S_BEGIN = 1 << 6 , SERD_LIST_O_BEGIN = 1 << 7 , SERD_LIST_CONT = 1 << 8 }
enum	SerdType { SERD_NOTHING = 0 , SERD_LITERAL = 1 , SERD_URI = 2 , SERD_CURIE = 3 , SERD_BLANK = 4 }
enum	SerdNodeFlag { SERD_HAS_NEWLINE = 1 , SERD_HAS_QUOTE = 1 << 1 }
enum	SerdStyle { SERD_STYLE_ABBREVIATED = 1 , SERD_STYLE_ASCII = 1 << 1 , SERD_STYLE_RESOLVED = 1 << 2 , SERD_STYLE_CURIED = 1 << 3 , SERD_STYLE_BULK = 1 << 4 }

Functions
SERD_API void	serd_free (void *SERD_NULLABLE ptr)

URI
typedef size_t(*	SerdSink) (const void buf, size_t len, void stream)
static const SerdURI	SERD_URI_NULL
SERD_API const uint8_t *	serd_uri_to_path (const uint8_t *uri)
SERD_API uint8_t *	serd_file_uri_parse (const uint8_t uri, uint8_t *hostname)
SERD_API bool	serd_uri_string_has_scheme (const uint8_t *utf8)
SERD_API SerdStatus	serd_uri_parse (const uint8_t utf8, SerdURI out)
SERD_API void	serd_uri_resolve (const SerdURI uri, const SerdURI base, SerdURI *out)
	See http://tools.ietf.org/html/rfc3986#section-5.2.2.
SERD_API size_t	serd_uri_serialise (const SerdURI uri, SerdSink sink, void stream)
	See http://tools.ietf.org/html/rfc3986#section-5.3.
SERD_API size_t	serd_uri_serialise_relative (const SerdURI uri, const SerdURI base, const SerdURI root, SerdSink sink, void stream)
	See http://tools.ietf.org/html/rfc3986#section-5.3.

Event Handlers
typedef SerdStatus(*	SerdErrorSink) (void handle, const SerdError error)
typedef SerdStatus(*	SerdBaseSink) (void handle, const SerdNode uri)
typedef SerdStatus(*	SerdPrefixSink) (void handle, const SerdNode name, const SerdNode *uri)
typedef SerdStatus(*	SerdStatementSink) (void handle, SerdStatementFlags flags, const SerdNode graph, const SerdNode subject, const SerdNode predicate, const SerdNode object, const SerdNode object_datatype, const SerdNode *object_lang)
typedef SerdStatus(*	SerdEndSink) (void handle, const SerdNode node)

Node
static const SerdNode	SERD_NODE_NULL = { NULL, 0, 0, 0, SERD_NOTHING }
SERD_API SerdNode	serd_node_from_string (SerdType type, const uint8_t *str)
SERD_API SerdNode	serd_node_copy (const SerdNode *node)
SERD_API bool	serd_node_equals (const SerdNode a, const SerdNode b)
SERD_API SerdNode	serd_node_new_uri_from_node (const SerdNode uri_node, const SerdURI base, SerdURI *out)
SERD_API SerdNode	serd_node_new_uri_from_string (const uint8_t str, const SerdURI base, SerdURI *out)
SERD_API SerdNode	serd_node_new_file_uri (const uint8_t path, const uint8_t hostname, SerdURI *out, bool escape)
SERD_API SerdNode	serd_node_new_uri (const SerdURI uri, const SerdURI base, SerdURI *out)
SERD_API SerdNode	serd_node_new_relative_uri (const SerdURI uri, const SerdURI base, const SerdURI root, SerdURI out)
SERD_API SerdNode	serd_node_new_decimal (double d, unsigned frac_digits)
SERD_API SerdNode	serd_node_new_integer (int64_t i)
	Create a new node by serialising i into an xsd:integer string.
SERD_API SerdNode	serd_node_new_blob (const void *buf, size_t size, bool wrap_lines)
SERD_API void	serd_node_free (SerdNode *node)

String Utilities
SERD_API const uint8_t *	serd_strerror (SerdStatus status)
	Return a string describing a status code.
SERD_API size_t	serd_strlen (const uint8_t str, size_t n_bytes, SerdNodeFlags *flags)
SERD_API double	serd_strtod (const char str, char *endptr)
SERD_API void *	serd_base64_decode (const uint8_t str, size_t len, size_t size)

Environment
SERD_API SerdEnv *	serd_env_new (const SerdNode *base_uri)
SERD_API void	serd_env_free (SerdEnv *env)
SERD_API const SerdNode *	serd_env_get_base_uri (const SerdEnv env, SerdURI out)
SERD_API SerdStatus	serd_env_set_base_uri (SerdEnv env, const SerdNode uri)
SERD_API SerdStatus	serd_env_set_prefix (SerdEnv env, const SerdNode name, const SerdNode *uri)
SERD_API SerdStatus	serd_env_set_prefix_from_strings (SerdEnv env, const uint8_t name, const uint8_t *uri)
SERD_API bool	serd_env_qualify (const SerdEnv env, const SerdNode uri, SerdNode prefix, SerdChunk suffix)
SERD_API SerdStatus	serd_env_expand (const SerdEnv env, const SerdNode curie, SerdChunk uri_prefix, SerdChunk uri_suffix)
SERD_API SerdNode	serd_env_expand_node (const SerdEnv env, const SerdNode node)
SERD_API void	serd_env_foreach (const SerdEnv env, SerdPrefixSink func, void handle)

Reader
SERD_API SerdReader *	serd_reader_new (SerdSyntax syntax, void handle, void(free_handle)(void *), SerdBaseSink base_sink, SerdPrefixSink prefix_sink, SerdStatementSink statement_sink, SerdEndSink end_sink)
SERD_API void	serd_reader_set_strict (SerdReader *reader, bool strict)
SERD_API void	serd_reader_set_error_sink (SerdReader reader, SerdErrorSink error_sink, void handle)
SERD_API void *	serd_reader_get_handle (const SerdReader *reader)
SERD_API void	serd_reader_add_blank_prefix (SerdReader reader, const uint8_t prefix)
SERD_API void	serd_reader_set_default_graph (SerdReader reader, const SerdNode graph)
SERD_API SerdStatus	serd_reader_read_file (SerdReader reader, const uint8_t uri)
SERD_API SerdStatus	serd_reader_start_stream (SerdReader me, FILE file, const uint8_t *name, bool bulk)
SERD_API SerdStatus	serd_reader_read_chunk (SerdReader *me)
SERD_API SerdStatus	serd_reader_end_stream (SerdReader *me)
SERD_API SerdStatus	serd_reader_read_file_handle (SerdReader reader, FILE file, const uint8_t *name)
SERD_API SerdStatus	serd_reader_read_string (SerdReader me, const uint8_t utf8)
SERD_API void	serd_reader_free (SerdReader *reader)

Writer
SERD_API SerdWriter *	serd_writer_new (SerdSyntax syntax, SerdStyle style, SerdEnv env, const SerdURI base_uri, SerdSink sink, void *stream)
SERD_API void	serd_writer_free (SerdWriter *writer)
SERD_API SerdEnv *	serd_writer_get_env (SerdWriter *writer)
SERD_API size_t	serd_file_sink (const void buf, size_t len, void stream)
SERD_API size_t	serd_chunk_sink (const void buf, size_t len, void stream)
SERD_API uint8_t *	serd_chunk_sink_finish (SerdChunk *stream)
SERD_API void	serd_writer_set_error_sink (SerdWriter writer, SerdErrorSink error_sink, void handle)
SERD_API void	serd_writer_chop_blank_prefix (SerdWriter writer, const uint8_t prefix)
SERD_API SerdStatus	serd_writer_set_base_uri (SerdWriter writer, const SerdNode uri)
SERD_API SerdStatus	serd_writer_set_root_uri (SerdWriter writer, const SerdNode uri)
SERD_API SerdStatus	serd_writer_set_prefix (SerdWriter writer, const SerdNode name, const SerdNode *uri)
SERD_API SerdStatus	serd_writer_write_statement (SerdWriter writer, SerdStatementFlags flags, const SerdNode graph, const SerdNode subject, const SerdNode predicate, const SerdNode object, const SerdNode object_datatype, const SerdNode *object_lang)
SERD_API SerdStatus	serd_writer_end_anon (SerdWriter writer, const SerdNode node)
SERD_API SerdStatus	serd_writer_finish (SerdWriter *writer)

Detailed Description

This is the complete public C API of serd.

A lightweight RDF syntax library.

Typedef Documentation

◆ SerdBaseSink

typedef SerdStatus(* SerdBaseSink) (void *handle, const SerdNode *uri)

Sink (callback) for base URI changes.

Called whenever the base URI of the serialisation changes.

◆ SerdEndSink

typedef SerdStatus(* SerdEndSink) (void *handle, const SerdNode *node)

Sink (callback) for anonymous node end markers.

This is called to indicate that the anonymous node with the given value will no longer be referred to by any future statements (i.e. the anonymous serialisation of the node is finished).

◆ SerdEnv [1/2]

typedef struct SerdEnvImpl SerdEnv

Lexical environment for relative URIs or CURIEs (base URI and namespaces).

◆ SerdEnv [2/2]

typedef struct SerdEnvImpl SerdEnv

Environment.

Represents the state required to resolve a CURIE or relative URI, e.g. the base URI and set of namespace prefixes at a particular point.

◆ SerdErrorSink

typedef SerdStatus(* SerdErrorSink) (void *handle, const SerdError *error)

Sink (callback) for errors.

Parameters

handle	Handle for user data.
error	Error description.

◆ SerdNodeFlags [1/2]

typedef uint32_t SerdNodeFlags

Bitwise OR of SerdNodeFlag values.

◆ SerdNodeFlags [2/2]

typedef uint32_t SerdNodeFlags

Bitwise OR of SerdNodeFlag values.

◆ SerdPrefixSink

typedef SerdStatus(* SerdPrefixSink) (void *handle, const SerdNode *name, const SerdNode *uri)

Sink (callback) for namespace definitions.

Called whenever a prefix is defined in the serialisation.

◆ SerdReader [1/2]

typedef struct SerdReaderImpl SerdReader

Streaming parser that reads a text stream and writes to a statement sink.

◆ SerdReader [2/2]

typedef struct SerdReaderImpl SerdReader

RDF reader.

Parses RDF by calling user-provided sink functions as input is consumed (much like an XML SAX parser).

◆ SerdSink

typedef size_t(* SerdSink) (const void *buf, size_t len, void *stream)

Sink function for raw string output.

◆ SerdStatementFlags [1/2]

typedef uint32_t SerdStatementFlags

Bitwise OR of SerdStatementFlag values.

◆ SerdStatementFlags [2/2]

typedef uint32_t SerdStatementFlags

Bitwise OR of SerdNodeFlag values.

◆ SerdStatementSink

typedef SerdStatus(* SerdStatementSink) (void *handle, SerdStatementFlags flags, const SerdNode *graph, const SerdNode *subject, const SerdNode *predicate, const SerdNode *object, const SerdNode *object_datatype, const SerdNode *object_lang)

Sink (callback) for statements.

Called for every RDF statement in the serialisation.

◆ SerdWriter [1/2]

typedef struct SerdWriterImpl SerdWriter

Streaming serialiser that writes a text stream as statements are pushed.

◆ SerdWriter [2/2]

typedef struct SerdWriterImpl SerdWriter

RDF writer.

Provides a number of functions to allow writing RDF syntax out to some stream. These functions are deliberately compatible with the sink functions used by SerdReader, so a reader can be directly connected to a writer to re-serialise a document with minimal overhead.

Enumeration Type Documentation

◆ SerdNodeFlag [1/2]

enum SerdNodeFlag

Flags indicating certain string properties relevant to serialisation.

Enumerator
SERD_HAS_NEWLINE	Contains line breaks ('\n' or '\r').
SERD_HAS_QUOTE	Contains quotes ('"').

◆ SerdNodeFlag [2/2]

enum SerdNodeFlag

Flags indicating certain string properties relevant to serialisation.

Enumerator
SERD_HAS_NEWLINE	Contains line breaks ('\n' or '\r')
SERD_HAS_QUOTE	Contains quotes ('"')

◆ SerdStatementFlag [1/2]

enum SerdStatementFlag

Flags indicating inline abbreviation information for a statement.

Enumerator
SERD_EMPTY_S	Empty blank node subject.
SERD_EMPTY_O	Empty blank node object.
SERD_ANON_S_BEGIN	Start of anonymous subject.
SERD_ANON_O_BEGIN	Start of anonymous object.
SERD_ANON_CONT	Continuation of anonymous node.
SERD_LIST_S_BEGIN	Start of list subject.
SERD_LIST_O_BEGIN	Start of list object.
SERD_LIST_CONT	Continuation of list.

◆ SerdStatementFlag [2/2]

enum SerdStatementFlag

Flags indication inline abbreviation information for a statement.

Enumerator
SERD_EMPTY_S	Empty blank node subject
SERD_EMPTY_O	Empty blank node object
SERD_ANON_S_BEGIN	Start of anonymous subject
SERD_ANON_O_BEGIN	Start of anonymous object
SERD_ANON_CONT	Continuation of anonymous node
SERD_LIST_S_BEGIN	Start of list subject
SERD_LIST_O_BEGIN	Start of list object
SERD_LIST_CONT	Continuation of list

◆ SerdStatus [1/2]

enum SerdStatus

Return status code.

Enumerator
SERD_SUCCESS	No error.
SERD_FAILURE	Non-fatal failure.
SERD_ERR_UNKNOWN	Unknown error.
SERD_ERR_BAD_SYNTAX	Invalid syntax.
SERD_ERR_BAD_ARG	Invalid argument.
SERD_ERR_NOT_FOUND	Not found.
SERD_ERR_ID_CLASH	Encountered clashing blank node IDs.
SERD_ERR_BAD_CURIE	Invalid CURIE (e.g. prefix does not exist).
SERD_ERR_INTERNAL	Unexpected internal error (should not happen).

◆ SerdStatus [2/2]

enum SerdStatus

Return status code.

Enumerator
SERD_SUCCESS	No error
SERD_FAILURE	Non-fatal failure
SERD_ERR_UNKNOWN	Unknown error
SERD_ERR_BAD_SYNTAX	Invalid syntax
SERD_ERR_BAD_ARG	Invalid argument
SERD_ERR_NOT_FOUND	Not found
SERD_ERR_ID_CLASH	Encountered clashing blank node IDs
SERD_ERR_BAD_CURIE	Invalid CURIE (e.g. prefix does not exist)
SERD_ERR_INTERNAL	Unexpected internal error (should not happen)

◆ SerdStyle [1/2]

enum SerdStyle

Syntax style options.

These flags allow more precise control of writer output style. Note that some options are only supported for some syntaxes, for example, NTriples does not support abbreviation and is always ASCII.

Enumerator
SERD_STYLE_ABBREVIATED	Abbreviate triples when possible.
SERD_STYLE_ASCII	Escape all non-ASCII characters.
SERD_STYLE_RESOLVED	Resolve URIs against base URI.
SERD_STYLE_CURIED	Shorten URIs into CURIEs.
SERD_STYLE_BULK	Write output in pages.

◆ SerdStyle [2/2]

enum SerdStyle

Syntax style options.

The style of the writer output can be controlled by ORing together values from this enumeration. Note that some options are only supported for some syntaxes (e.g. NTriples does not support abbreviation and is always ASCII).

Enumerator
SERD_STYLE_ABBREVIATED	Abbreviate triples when possible.
SERD_STYLE_ASCII	Escape all non-ASCII characters.
SERD_STYLE_RESOLVED	Resolve URIs against base URI.
SERD_STYLE_CURIED	Shorten URIs into CURIEs.
SERD_STYLE_BULK	Write output in pages.

◆ SerdSyntax [1/2]

enum SerdSyntax

RDF syntax type.

Enumerator
SERD_TURTLE	Terse triples http://www.w3.org/TR/turtle.
SERD_NTRIPLES	Line-based triples http://www.w3.org/TR/n-triples/.
SERD_NQUADS	Line-based quads http://www.w3.org/TR/n-quads/.
SERD_TRIG	Terse quads http://www.w3.org/TR/trig/.

◆ SerdSyntax [2/2]

enum SerdSyntax

RDF syntax type.

Enumerator

SERD_TURTLE

Turtle - Terse RDF Triple Language (UTF-8).

See also: Turtle

SERD_NTRIPLES

NTriples - Line-based RDF triples (ASCII).

See also: NTriples

◆ SerdType [1/2]

enum SerdType

Type of a node.

An RDF node, in the abstract sense, can be either a resource, literal, or a blank. This type is more precise, because syntactically there are two ways to refer to a resource (by URI or CURIE).

There are also two ways to refer to a blank node in syntax (by ID or anonymously), but this is handled by statement flags rather than distinct node types.

Enumerator
SERD_NOTHING	The type of a nonexistent node. This type is useful as a sentinel, but is never emitted by the reader.
SERD_LITERAL	Literal value. A literal optionally has either a language, or a datatype (not both).
SERD_URI	URI (absolute or relative). Value is an unquoted URI string, which is either a relative reference with respect to the current base URI (e.g. "foo/bar"), or an absolute URI (e.g. "http://example.org/foo"). See also RFC3986
SERD_CURIE	CURIE, a shortened URI. Value is an unquoted CURIE string relative to the current environment, e.g. "rdf:type". See also CURIE Syntax 1.0
SERD_BLANK	A blank node. Value is a blank node ID without any syntactic prefix, like "id3", which is meaningful only within this serialisation. See also RDF 1.1 Turtle

◆ SerdType [2/2]

enum SerdType

Type of a syntactic RDF node.

This is more precise than the type of an abstract RDF node. An abstract node is either a resource, literal, or blank. In syntax there are two ways to refer to a resource (by URI or CURIE) and two ways to refer to a blank (by ID or anonymously). Anonymous (inline) blank nodes are expressed using SerdStatementFlags rather than this type.

Enumerator
SERD_NOTHING	The type of a nonexistent node. This type is useful as a sentinel, but is never emitted by the reader.
SERD_LITERAL	Literal value. A literal optionally has either a language, or a datatype (not both).
SERD_URI	URI (absolute or relative). Value is an unquoted URI string, which is either a relative reference with respect to the current base URI (e.g. "foo/bar"), or an absolute URI (e.g. "http://example.org/foo"). See also RFC3986.
SERD_CURIE	CURIE, a shortened URI. Value is an unquoted CURIE string relative to the current environment, e.g. "rdf:type". See also CURIE Syntax 1.0
SERD_BLANK	A blank node. Value is a blank node ID, e.g. "id3", which is meaningful only within this serialisation. See also Turtle nodeID

Function Documentation

◆ serd_base64_decode()

SERD_API void * serd_base64_decode	(	const uint8_t *	str,
		size_t	len,
		size_t *	size )

Decode a base64 string. This function can be used to deserialise a blob node created with serd_node_new_blob().

Parameters

str	Base64 string to decode.
len	The length of str.
size	Set to the size of the returned blob in bytes.

Returns: A newly allocated blob which must be freed with free().

◆ serd_chunk_sink()

SERD_API size_t serd_chunk_sink	(	const void *	buf,
		size_t	len,
		void *	stream )

A convenience sink function for writing to a string.

This function can be used as a SerdSink to write to a SerdChunk which is resized as necessary with realloc(). The stream parameter must point to an initialized SerdChunk. When the write is finished, the string should be retrieved with serd_chunk_sink_finish().

◆ serd_chunk_sink_finish()

SERD_API uint8_t * serd_chunk_sink_finish ( SerdChunk * stream )

Finish a serialisation to a chunk with serd_chunk_sink().

The returned string is the result of the serialisation, which is NULL terminated (by this function) and owned by the caller.

◆ serd_env_expand()

SERD_API SerdStatus serd_env_expand	(	const SerdEnv *	env,
		const SerdNode *	curie,
		SerdChunk *	uri_prefix,
		SerdChunk *	uri_suffix )

Expand curie.

◆ serd_env_expand_node()

SERD_API SerdNode serd_env_expand_node	(	const SerdEnv *	env,
		const SerdNode *	node )

Expand node, which must be a CURIE or URI, to a full URI.

◆ serd_env_foreach()

SERD_API void serd_env_foreach	(	const SerdEnv *	env,
		SerdPrefixSink	func,
		void *	handle )

Call func for each prefix defined in env.

◆ serd_env_free()

SERD_API void serd_env_free ( SerdEnv * env )

Free ns.

◆ serd_env_get_base_uri()

SERD_API const SerdNode * serd_env_get_base_uri	(	const SerdEnv *	env,
		SerdURI *	out )

Get the current base URI.

◆ serd_env_new()

SERD_API SerdEnv * serd_env_new ( const SerdNode * base_uri )

Create a new environment.

◆ serd_env_qualify()

SERD_API bool serd_env_qualify	(	const SerdEnv *	env,
		const SerdNode *	uri,
		SerdNode *	prefix,
		SerdChunk *	suffix )

Qualify uri into a CURIE if possible.

◆ serd_env_set_base_uri()

SERD_API SerdStatus serd_env_set_base_uri	(	SerdEnv *	env,
		const SerdNode *	uri )

Set the current base URI.

◆ serd_env_set_prefix()

SERD_API SerdStatus serd_env_set_prefix	(	SerdEnv *	env,
		const SerdNode *	name,
		const SerdNode *	uri )

Set a namespace prefix.

◆ serd_env_set_prefix_from_strings()

SERD_API SerdStatus serd_env_set_prefix_from_strings	(	SerdEnv *	env,
		const uint8_t *	name,
		const uint8_t *	uri )

Set a namespace prefix.

◆ serd_file_sink()

SERD_API size_t serd_file_sink	(	const void *	buf,
		size_t	len,
		void *	stream )

A convenience sink function for writing to a FILE*.

This function can be used as a SerdSink when writing to a FILE*. The stream parameter must be a FILE* opened for writing.

◆ serd_file_uri_parse()

SERD_API uint8_t * serd_file_uri_parse	(	const uint8_t *	uri,
		uint8_t **	hostname )

Get the unescaped path and hostname from a file URI.

Parameters

uri	A file URI.
hostname	If non-NULL, set to the hostname, if present.

Returns: The path component of the URI.

The returned path and *hostname must be freed with free().

◆ serd_free()

SERD_API void serd_free ( void *SERD_NULLABLE ptr )

Free memory allocated by Serd

This function exists because some systems require memory allocated by a library to be freed by code in the same library. It is otherwise equivalent to the standard C free() function.

◆ serd_node_copy()

SERD_API SerdNode serd_node_copy ( const SerdNode * node )

Make a deep copy of node.

Returns: a node that the caller must free with serd_node_free().

◆ serd_node_equals()

SERD_API bool serd_node_equals	(	const SerdNode *	a,
		const SerdNode *	b )

Return true iff a is equal to b.

◆ serd_node_free()

SERD_API void serd_node_free ( SerdNode * node )

Free any data owned by node.

Note that if node is itself dynamically allocated (which is not the case for nodes created internally by serd), it will not be freed.

◆ serd_node_from_string()

SERD_API SerdNode serd_node_from_string	(	SerdType	type,
		const uint8_t *	str )

Make a (shallow) node from str.

This measures, but does not copy, str. No memory is allocated.

◆ serd_node_new_blob()

SERD_API SerdNode serd_node_new_blob	(	const void *	buf,
		size_t	size,
		bool	wrap_lines )

Create a node by serialising buf into an xsd:base64Binary string. This function can be used to make a serialisable node out of arbitrary binary data, which can be decoded using serd_base64_decode().

Parameters

buf	Raw binary input data.
size	Size of buf.
wrap_lines	Wrap lines at 76 characters to conform to RFC 2045.

◆ serd_node_new_decimal()

SERD_API SerdNode serd_node_new_decimal	(	double	d,
		unsigned	frac_digits )

Create a new node by serialising d into an xsd:decimal string.

The resulting node will always contain a .', start with a digit, and end with a digit (i.e. will have a leading and/or trailing 0' if necessary). It will never be in scientific notation. A maximum of frac_digits digits will be written after the decimal point, but trailing zeros will automatically be omitted (except one if d is a round integer).

Note that about 16 and 8 fractional digits are required to precisely represent a double and float, respectively.

Parameters

d	The value for the new node.
frac_digits	The maximum number of digits after the decimal place.

Create a new node by serialising d into an xsd:decimal string

The resulting node will always contain a .', start with a digit, and end with a digit (i.e. will have a leading and/or trailing 0' if necessary). It will never be in scientific notation. A maximum of frac_digits digits will be written after the decimal point, but trailing zeros will automatically be omitted (except one if d is a round integer).

Note that about 16 and 8 fractional digits are required to precisely represent a double and float, respectively.

Parameters

d	The value for the new node.
frac_digits	The maximum number of digits after the decimal place.

◆ serd_node_new_file_uri()

SERD_API SerdNode serd_node_new_file_uri	(	const uint8_t *	path,
		const uint8_t *	hostname,
		SerdURI *	out,
		bool	escape )

Create a new file URI node from a file system path and optional hostname.

Backslashes in Windows paths will be converted and '' will always be percent encoded. If escape is true, all other invalid characters will be percent encoded as well.

If path is relative, hostname is ignored. If out is not NULL, it will be set to the parsed URI.

◆ serd_node_new_integer()

SERD_API SerdNode serd_node_new_integer ( int64_t i )

Create a new node by serialising i into an xsd:integer string.

◆ serd_node_new_relative_uri()

SERD_API SerdNode serd_node_new_relative_uri	(	const SerdURI *	uri,
		const SerdURI *	base,
		const SerdURI *	root,
		SerdURI *	out )

Create a new node by serialising uri into a new relative URI.

Parameters

uri	The URI to serialise.
base	Base URI to make uri relative to, if possible.
root	Root URI for resolution (see serd_uri_serialise_relative()).
out	Set to the parsing of the new URI (i.e. points only to memory owned by the new returned node).

◆ serd_node_new_uri()

SERD_API SerdNode serd_node_new_uri	(	const SerdURI *	uri,
		const SerdURI *	base,
		SerdURI *	out )

Create a new node by serialising uri into a new string.

Parameters

uri	The URI to serialise.
base	Base URI to resolve uri against (or NULL for no resolution).
out	Set to the parsing of the new URI (i.e. points only to memory owned by the new returned node).

◆ serd_node_new_uri_from_node()

SERD_API SerdNode serd_node_new_uri_from_node	(	const SerdNode *	uri_node,
		const SerdURI *	base,
		SerdURI *	out )

Simple wrapper for serd_node_new_uri() to resolve a URI node.

◆ serd_node_new_uri_from_string()

SERD_API SerdNode serd_node_new_uri_from_string	(	const uint8_t *	str,
		const SerdURI *	base,
		SerdURI *	out )

Simple wrapper for serd_node_new_uri() to resolve a URI string.

◆ serd_reader_add_blank_prefix()

SERD_API void serd_reader_add_blank_prefix	(	SerdReader *	reader,
		const uint8_t *	prefix )

Set a prefix to be added to all blank node identifiers.

This is useful when multiple files are to be parsed into the same output (e.g. a store, or other files). Since Serd preserves blank node IDs, this could cause conflicts where two non-equivalent blank nodes are merged, resulting in corrupt data. By setting a unique blank node prefix for each parsed file, this can be avoided, while preserving blank node names.

◆ serd_reader_end_stream()

SERD_API SerdStatus serd_reader_end_stream ( SerdReader * me )

Finish an incremental read from a file handle.

◆ serd_reader_free()

SERD_API void serd_reader_free ( SerdReader * reader )

Free reader.

◆ serd_reader_get_handle()

SERD_API void * serd_reader_get_handle ( const SerdReader * reader )

Return the handle passed to serd_reader_new().

◆ serd_reader_new()

SERD_API SerdReader * serd_reader_new	(	SerdSyntax	syntax,
		void *	handle,
		void(*	free_handle )(void *),
		SerdBaseSink	base_sink,
		SerdPrefixSink	prefix_sink,
		SerdStatementSink	statement_sink,
		SerdEndSink	end_sink )

Create a new RDF reader.

◆ serd_reader_read_chunk()

SERD_API SerdStatus serd_reader_read_chunk ( SerdReader * me )

Read a single "chunk" of data during an incremental read.

This function will read a single top level description, and return. This may be a directive, statement, or several statements; essentially it reads until a '.' is encountered. This is particularly useful for reading directly from a pipe or socket.

◆ serd_reader_read_file()

SERD_API SerdStatus serd_reader_read_file	(	SerdReader *	reader,
		const uint8_t *	uri )

Read a file at a given uri.

◆ serd_reader_read_file_handle()

SERD_API SerdStatus serd_reader_read_file_handle	(	SerdReader *	reader,
		FILE *	file,
		const uint8_t *	name )

Read file.

◆ serd_reader_read_string()

SERD_API SerdStatus serd_reader_read_string	(	SerdReader *	me,
		const uint8_t *	utf8 )

Read utf8.

◆ serd_reader_set_default_graph()

SERD_API void serd_reader_set_default_graph	(	SerdReader *	reader,
		const SerdNode *	graph )

Set the URI of the default graph.

If this is set, the reader will emit quads with the graph set to the given node for any statements that are not in a named graph (which is currently all of them since Serd currently does not support any graph syntaxes).

◆ serd_reader_set_error_sink()

SERD_API void serd_reader_set_error_sink	(	SerdReader *	reader,
		SerdErrorSink	error_sink,
		void *	handle )

Set a function to be called when errors occur during reading.

The error_sink will be called with handle as its first argument. If no error function is set, errors are printed to stderr in GCC style.

◆ serd_reader_set_strict()

SERD_API void serd_reader_set_strict	(	SerdReader *	reader,
		bool	strict )

Enable or disable strict parsing.

The reader is non-strict (lax) by default, which will tolerate URIs with invalid characters. Setting strict will fail when parsing such files. An error is printed for invalid input in either case.

◆ serd_reader_start_stream()

SERD_API SerdStatus serd_reader_start_stream	(	SerdReader *	me,
		FILE *	file,
		const uint8_t *	name,
		bool	bulk )

Start an incremental read from a file handle.

Iff bulk is true, file will be read a page at a time. This is more efficient, but uses a page of memory and means that an entire page of input must be ready before any callbacks will fire. To react as soon as input arrives, set bulk to false.

◆ serd_strerror()

SERD_API const uint8_t * serd_strerror ( SerdStatus status )

Return a string describing a status code.

◆ serd_strlen()

SERD_API size_t serd_strlen	(	const uint8_t *	str,
		size_t *	n_bytes,
		SerdNodeFlags *	flags )

Measure a UTF-8 string.

Returns: Length of str in characters (except NULL).

Parameters

str	A null-terminated UTF-8 string.
n_bytes	(Output) Set to the size of str in bytes (except NULL).
flags	(Output) Set to the applicable flags.

◆ serd_strtod()

SERD_API double serd_strtod	(	const char *	str,
		char **	endptr )

Parse a string to a double.

The API of this function is identical to the standard C strtod function, except this function is locale-independent and always matches the lexical format used in the Turtle grammar (the decimal point is always ".").

◆ serd_uri_parse()

SERD_API SerdStatus serd_uri_parse	(	const uint8_t *	utf8,
		SerdURI *	out )

Parse utf8, writing result to out.

◆ serd_uri_resolve()

SERD_API void serd_uri_resolve	(	const SerdURI *	uri,
		const SerdURI *	base,
		SerdURI *	out )

See http://tools.ietf.org/html/rfc3986#section-5.2.2.

Set out to uri resolved against base.

◆ serd_uri_serialise()

SERD_API size_t serd_uri_serialise	(	const SerdURI *	uri,
		SerdSink	sink,
		void *	stream )

See http://tools.ietf.org/html/rfc3986#section-5.3.

Serialise uri with a series of calls to sink.

◆ serd_uri_serialise_relative()

SERD_API size_t serd_uri_serialise_relative	(	const SerdURI *	uri,
		const SerdURI *	base,
		const SerdURI *	root,
		SerdSink	sink,
		void *	stream )

See http://tools.ietf.org/html/rfc3986#section-5.3.

Serialise uri relative to base with a series of calls to sink.

The uri is written as a relative URI iff if it a child of base and root. The optional root parameter must be a prefix of base and can be used keep up-references ("../") within a certain namespace.

◆ serd_uri_string_has_scheme()

SERD_API bool serd_uri_string_has_scheme ( const uint8_t * utf8 )

Return true iff utf8 starts with a valid URI scheme.

◆ serd_uri_to_path()

SERD_API const uint8_t * serd_uri_to_path ( const uint8_t * uri )

Return the local path for uri, or NULL if uri is not a file URI. Note this (inappropriately named) function only removes the file scheme if necessary, and returns uri unmodified if it is an absolute path. Percent encoding and other issues are not handled, to properly convert a file URI to a path, use serd_file_uri_parse().

◆ serd_writer_chop_blank_prefix()

SERD_API void serd_writer_chop_blank_prefix	(	SerdWriter *	writer,
		const uint8_t *	prefix )

Set a prefix to be removed from matching blank node identifiers.

◆ serd_writer_end_anon()

SERD_API SerdStatus serd_writer_end_anon	(	SerdWriter *	writer,
		const SerdNode *	node )

Mark the end of an anonymous node's description.

Note this function can be safely casted to SerdEndSink.

◆ serd_writer_finish()

SERD_API SerdStatus serd_writer_finish ( SerdWriter * writer )

Finish a write.

◆ serd_writer_free()

SERD_API void serd_writer_free ( SerdWriter * writer )

Free writer.

◆ serd_writer_get_env()

SERD_API SerdEnv * serd_writer_get_env ( SerdWriter * writer )

Return the env used by writer.

◆ serd_writer_new()

SERD_API SerdWriter * serd_writer_new	(	SerdSyntax	syntax,
		SerdStyle	style,
		SerdEnv *	env,
		const SerdURI *	base_uri,
		SerdSink	sink,
		void *	stream )

Create a new RDF writer.

◆ serd_writer_set_base_uri()

SERD_API SerdStatus serd_writer_set_base_uri	(	SerdWriter *	writer,
		const SerdNode *	uri )

Set the current output base URI (and emit directive if applicable).

Note this function can be safely casted to SerdBaseSink.

◆ serd_writer_set_error_sink()

SERD_API void serd_writer_set_error_sink	(	SerdWriter *	writer,
		SerdErrorSink	error_sink,
		void *	handle )

Set a function to be called when errors occur during writing.

The error_sink will be called with handle as its first argument. If no error function is set, errors are printed to stderr.

◆ serd_writer_set_prefix()

SERD_API SerdStatus serd_writer_set_prefix	(	SerdWriter *	writer,
		const SerdNode *	name,
		const SerdNode *	uri )

Set a namespace prefix (and emit directive if applicable).

Note this function can be safely casted to SerdPrefixSink.

◆ serd_writer_set_root_uri()

SERD_API SerdStatus serd_writer_set_root_uri	(	SerdWriter *	writer,
		const SerdNode *	uri )

Set the current root URI.

The root URI should be a prefix of the base URI. The path of the root URI is the highest path any relative up-reference can refer to. For example, with root file:///foo/root and base file:///foo/root/base, file:///foo/root will be written as <../>, but file:///foo will be written non-relatively as file:///foo. If the root is not explicitly set, it defaults to the base URI, so no up-references will be created at all.

◆ serd_writer_write_statement()

SERD_API SerdStatus serd_writer_write_statement	(	SerdWriter *	writer,
		SerdStatementFlags	flags,
		const SerdNode *	graph,
		const SerdNode *	subject,
		const SerdNode *	predicate,
		const SerdNode *	object,
		const SerdNode *	object_datatype,
		const SerdNode *	object_lang )

Write a statement.

Note this function can be safely casted to SerdStatementSink.

Variable Documentation

◆ SERD_NODE_NULL

const SerdNode SERD_NODE_NULL = { NULL, 0, 0, 0, SERD_NOTHING }

static

◆ SERD_URI_NULL

const SerdURI SERD_URI_NULL

static

Initial value:

                                   = {
        {NULL, 0}, {NULL, 0}, {NULL, 0}, {NULL, 0}, {NULL, 0}, {NULL, 0}
}

Topics

Classes

Typedefs

Enumerations

Functions

URI

Event Handlers

Node

String Utilities

Environment

Reader

Writer

Detailed Description

Typedef Documentation

◆ SerdBaseSink

◆ SerdEndSink

◆ SerdEnv [1/2]

◆ SerdEnv [2/2]

◆ SerdErrorSink

◆ SerdNodeFlags [1/2]

◆ SerdNodeFlags [2/2]

◆ SerdPrefixSink

◆ SerdReader [1/2]

◆ SerdReader [2/2]

◆ SerdSink

◆ SerdStatementFlags [1/2]

◆ SerdStatementFlags [2/2]

◆ SerdStatementSink

◆ SerdWriter [1/2]

◆ SerdWriter [2/2]

Enumeration Type Documentation

◆ SerdNodeFlag [1/2]

◆ SerdNodeFlag [2/2]

◆ SerdStatementFlag [1/2]

◆ SerdStatementFlag [2/2]

◆ SerdStatus [1/2]

◆ SerdStatus [2/2]

◆ SerdStyle [1/2]

◆ SerdStyle [2/2]

◆ SerdSyntax [1/2]

◆ SerdSyntax [2/2]

◆ SerdType [1/2]

◆ SerdType [2/2]

Function Documentation

◆ serd_base64_decode()

◆ serd_chunk_sink()

◆ serd_chunk_sink_finish()

◆ serd_env_expand()

◆ serd_env_expand_node()

◆ serd_env_foreach()

◆ serd_env_free()

◆ serd_env_get_base_uri()

◆ serd_env_new()

◆ serd_env_qualify()

◆ serd_env_set_base_uri()

◆ serd_env_set_prefix()

◆ serd_env_set_prefix_from_strings()

◆ serd_file_sink()

◆ serd_file_uri_parse()

◆ serd_free()

◆ serd_node_copy()

◆ serd_node_equals()

◆ serd_node_free()

◆ serd_node_from_string()

◆ serd_node_new_blob()

◆ serd_node_new_decimal()

◆ serd_node_new_file_uri()

◆ serd_node_new_integer()

◆ serd_node_new_relative_uri()

◆ serd_node_new_uri()

◆ serd_node_new_uri_from_node()

◆ serd_node_new_uri_from_string()

◆ serd_reader_add_blank_prefix()

◆ serd_reader_end_stream()

◆ serd_reader_free()

◆ serd_reader_get_handle()

◆ serd_reader_new()

◆ serd_reader_read_chunk()

◆ serd_reader_read_file()

◆ serd_reader_read_file_handle()