Environment

Functions
SERD_API SerdEnv *SERD_ALLOCATED	serd_env_new (const SerdNode *SERD_NULLABLE base_uri)
	Create a new environment.
SERD_API void	serd_env_free (SerdEnv *SERD_NULLABLE env)
	Free env.
SERD_API const SerdNode *SERD_NONNULL	serd_env_get_base_uri (const SerdEnv *SERD_NONNULL env, SerdURI *SERD_NULLABLE out)
	Get the current base URI.
SERD_API SerdStatus	serd_env_set_base_uri (SerdEnv *SERD_NONNULL env, const SerdNode *SERD_NULLABLE uri)
	Set the current base URI.
SERD_API SerdStatus	serd_env_set_prefix (SerdEnv *SERD_NONNULL env, const SerdNode *SERD_NONNULL name, const SerdNode *SERD_NONNULL uri)
SERD_API SerdStatus	serd_env_set_prefix_from_strings (SerdEnv *SERD_NONNULL env, const uint8_t *SERD_NONNULL name, const uint8_t *SERD_NONNULL uri)
	Set a namespace prefix.
SERD_API bool	serd_env_qualify (const SerdEnv *SERD_NONNULL env, const SerdNode *SERD_NONNULL uri, SerdNode *SERD_NONNULL prefix, SerdChunk *SERD_NONNULL suffix)
	Qualify uri into a CURIE if possible.
SERD_API SerdStatus	serd_env_expand (const SerdEnv *SERD_NONNULL env, const SerdNode *SERD_NONNULL curie, SerdChunk *SERD_NONNULL uri_prefix, SerdChunk *SERD_NONNULL uri_suffix)
SERD_API SerdNode	serd_env_expand_node (const SerdEnv *SERD_NONNULL env, const SerdNode *SERD_NONNULL node)
SERD_API void	serd_env_foreach (const SerdEnv *SERD_NONNULL env, SerdPrefixSink SERD_NONNULL func, void *SERD_NULLABLE handle)
	Call func for each prefix defined in env.

Detailed Description

Function Documentation

serd_env_expand()

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

Expand curie.

Errors: SERD_ERR_BAD_ARG if curie is not valid, or SERD_ERR_BAD_CURIE if prefix is not defined in env.

serd_env_expand_node()

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

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

Returns null if node can not be expanded.

serd_env_foreach()

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

Call func for each prefix defined in env.

serd_env_free()

SERD_API void serd_env_free

(

SerdEnv *SERD_NULLABLE

env

)

Free env.

serd_env_get_base_uri()

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

Get the current base URI.

serd_env_new()

SERD_API SerdEnv *SERD_ALLOCATED serd_env_new

(

const SerdNode *SERD_NULLABLE

base_uri

)

Create a new environment.

serd_env_qualify()

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

Qualify uri into a CURIE if possible.

serd_env_set_base_uri()

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

Set the current base URI.

serd_env_set_prefix()

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

Set a namespace prefix

A namespace prefix is used to expand CURIE nodes, for example, with the prefix "xsd" set to "http://www.w3.org/2001/XMLSchema#", "xsd:decimal" will expand to "http://www.w3.org/2001/XMLSchema#decimal".

serd_env_set_prefix_from_strings()

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

Set a namespace prefix.