Functions to inspect and change nix Value's. More...

Typedefs
typedef struct BindingsBuilder	BindingsBuilder
	Stores an under-construction set of bindings. More...

Functions
BindingsBuilder *	nix_make_bindings_builder (nix_c_context context, State state, size_t capacity)
	Create a bindings builder. More...

nix_err	nix_bindings_builder_insert (nix_c_context context, BindingsBuilder builder, const char name, Value value)
	Insert bindings into a builder. More...

void	nix_bindings_builder_free (BindingsBuilder *builder)
	Free a bindings builder. More...

Getters
ValueType	nix_get_type (nix_c_context context, const Value value)
	Get value type. More...

const char *	nix_get_typename (nix_c_context context, const Value value)
	Get type name of value. More...

bool	nix_get_bool (nix_c_context context, const Value value)
	Get boolean value. More...

const char *	nix_get_string (nix_c_context context, const Value value)
	Get string. More...

const char *	nix_get_path_string (nix_c_context context, const Value value)
	Get path as string. More...

unsigned int	nix_get_list_size (nix_c_context context, const Value value)
	Get the length of a list. More...

unsigned int	nix_get_attrs_size (nix_c_context context, const Value value)
	Get the element count of an attrset. More...

double	nix_get_float (nix_c_context context, const Value value)
	Get float value in 64 bits. More...

int64_t	nix_get_int (nix_c_context context, const Value value)
	Get int value. More...

ExternalValue *	nix_get_external (nix_c_context context, Value )
	Get external reference. More...

Value *	nix_get_list_byidx (nix_c_context context, const Value value, State *state, unsigned int ix)
	Get the ix'th element of a list. More...

Value *	nix_get_attr_byname (nix_c_context context, const Value value, State state, const char name)
	Get an attr by name. More...

bool	nix_has_attr_byname (nix_c_context context, const Value value, State state, const char name)
	Check if an attribute name exists on a value. More...

Value *	nix_get_attr_byidx (nix_c_context context, const Value value, State state, unsigned int i, const char *name)
	Get an attribute by index in the sorted bindings. More...

const char *	nix_get_attr_name_byidx (nix_c_context context, const Value value, State *state, unsigned int i)
	Get an attribute name by index in the sorted bindings. More...

Setters
nix_err	nix_set_bool (nix_c_context context, Value value, bool b)
	Set boolean value. More...

nix_err	nix_set_string (nix_c_context context, Value value, const char *str)
	Set a string. More...

nix_err	nix_set_path_string (nix_c_context context, Value value, const char *str)
	Set a path. More...

nix_err	nix_set_float (nix_c_context context, Value value, double d)
	Set a float. More...

nix_err	nix_set_int (nix_c_context context, Value value, int64_t i)
	Set an int. More...

nix_err	nix_set_null (nix_c_context context, Value value)
	Set null. More...

nix_err	nix_set_external (nix_c_context context, Value value, ExternalValue *val)
	Set an external value. More...

nix_err	nix_make_list (nix_c_context context, State s, Value *value, unsigned int size)
	Allocate a list. More...

nix_err	nix_set_list_byidx (nix_c_context context, Value value, unsigned int ix, Value *elem)
	Manipulate a list by index. More...

nix_err	nix_make_attrs (nix_c_context context, Value value, BindingsBuilder *b)
	Create an attribute set from a bindings builder. More...

nix_err	nix_set_primop (nix_c_context context, Value value, PrimOp *op)
	Set primop. More...

nix_err	nix_copy_value (nix_c_context context, Value value, Value *source)
	Copy from another value. More...

Detailed Description

Functions to inspect and change nix Value's.

Typedef Documentation

◆ BindingsBuilder

typedef struct BindingsBuilder BindingsBuilder

Stores an under-construction set of bindings.

Do not reuse.

See also: nix_make_bindings_builder, nix_bindings_builder_free, nix_make_attrs; nix_bindings_builder_insert

Function Documentation

◆ nix_bindings_builder_free()

void nix_bindings_builder_free ( BindingsBuilder * builder )

Free a bindings builder.

Does not fail.

Parameters

[in] builder the builder to free

◆ nix_bindings_builder_insert()

nix_err nix_bindings_builder_insert	(	nix_c_context *	context,
		BindingsBuilder *	builder,
		const char *	name,
		Value *	value
	)

Insert bindings into a builder.

Parameters

[out]	context	Optional, stores error information
[in]	builder	BindingsBuilder to insert into
[in]	name	attribute name, copied into the symbol store
[in]	value	value to give the binding

Returns: error code, NIX_OK on success.

◆ nix_copy_value()

nix_err nix_copy_value	(	nix_c_context *	context,
		Value *	value,
		Value *	source
	)

Copy from another value.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	source	value to copy from

Returns: error code, NIX_OK on success.

◆ nix_get_attr_byidx()

Value * nix_get_attr_byidx	(	nix_c_context *	context,
		const Value *	value,
		State *	state,
		unsigned int	i,
		const char **	name
	)

Get an attribute by index in the sorted bindings.

Also gives you the name.

Owned by the GC. Use nix_gc_decref when you're done with the pointer

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect
[in]	state	nix evaluator state
[in]	i	attribute index
[out]	name	will store a pointer to the attribute name

Returns: value, NULL in case of errors

◆ nix_get_attr_byname()

Value * nix_get_attr_byname	(	nix_c_context *	context,
		const Value *	value,
		State *	state,
		const char *	name
	)

Get an attr by name.

Owned by the GC. Use nix_gc_decref when you're done with the pointer

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect
[in]	state	nix evaluator state
[in]	name	attribute name

Returns: value, NULL in case of errors

◆ nix_get_attr_name_byidx()

const char * nix_get_attr_name_byidx	(	nix_c_context *	context,
		const Value *	value,
		State *	state,
		unsigned int	i
	)

Get an attribute name by index in the sorted bindings.

Useful when you want the name but want to avoid evaluation.

Owned by the nix State

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect
[in]	state	nix evaluator state
[in]	i	attribute index

Returns: name, NULL in case of errors

◆ nix_get_attrs_size()

unsigned int nix_get_attrs_size	(	nix_c_context *	context,
		const Value *	value
	)

Get the element count of an attrset.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: attrset element count, error info via context

◆ nix_get_bool()

bool nix_get_bool	(	nix_c_context *	context,
		const Value *	value
	)

Get boolean value.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: true or false, error info via context

◆ nix_get_external()

ExternalValue * nix_get_external	(	nix_c_context *	context,
		Value *
	)

Get external reference.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: reference to external, NULL in case of error

◆ nix_get_float()

double nix_get_float	(	nix_c_context *	context,
		const Value *	value
	)

Get float value in 64 bits.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: float contents, error info via context

◆ nix_get_int()

int64_t nix_get_int	(	nix_c_context *	context,
		const Value *	value
	)

Get int value.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: int contents, error info via context

◆ nix_get_list_byidx()

Value * nix_get_list_byidx	(	nix_c_context *	context,
		const Value *	value,
		State *	state,
		unsigned int	ix
	)

Get the ix'th element of a list.

Owned by the GC. Use nix_gc_decref when you're done with the pointer

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect
[in]	state	nix evaluator state
[in]	ix	list element to get

Returns: value, NULL in case of errors

◆ nix_get_list_size()

unsigned int nix_get_list_size	(	nix_c_context *	context,
		const Value *	value
	)

Get the length of a list.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: length of list, error info via context

◆ nix_get_path_string()

const char * nix_get_path_string	(	nix_c_context *	context,
		const Value *	value
	)

Get path as string.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: string; NULL in case of error.

◆ nix_get_string()

const char * nix_get_string	(	nix_c_context *	context,
		const Value *	value
	)

Get string.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: string; NULL in case of error.

◆ nix_get_type()

ValueType nix_get_type	(	nix_c_context *	context,
		const Value *	value
	)

Get value type.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: type of nix value

◆ nix_get_typename()

const char * nix_get_typename	(	nix_c_context *	context,
		const Value *	value
	)

Get type name of value.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect

Returns: type name, owned string

Todo:: way to free the result

◆ nix_has_attr_byname()

bool nix_has_attr_byname	(	nix_c_context *	context,
		const Value *	value,
		State *	state,
		const char *	name
	)

Check if an attribute name exists on a value.

Parameters

[out]	context	Optional, stores error information
[in]	value	Nix value to inspect
[in]	state	nix evaluator state
[in]	name	attribute name

Returns: value, error info via context

◆ nix_make_attrs()

nix_err nix_make_attrs	(	nix_c_context *	context,
		Value *	value,
		BindingsBuilder *	b
	)

Create an attribute set from a bindings builder.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	b	bindings builder to use. Make sure to unref this afterwards.

Returns: error code, NIX_OK on success.

◆ nix_make_bindings_builder()

BindingsBuilder * nix_make_bindings_builder	(	nix_c_context *	context,
		State *	state,
		size_t	capacity
	)

Create a bindings builder.

Parameters

[out]	context	Optional, stores error information
[in]	state	nix evaluator state
[in]	capacity	how many bindings you'll add. Don't exceed.

Returns: owned reference to a bindings builder. Make sure to unref when you're done.

◆ nix_make_list()

nix_err nix_make_list	(	nix_c_context *	context,
		State *	s,
		Value *	value,
		unsigned int	size
	)

Allocate a list.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	size	size of list

Returns: error code, NIX_OK on success.

◆ nix_set_bool()

nix_err nix_set_bool	(	nix_c_context *	context,
		Value *	value,
		bool	b
	)

Set boolean value.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	b	the boolean value

Returns: error code, NIX_OK on success.

◆ nix_set_external()

nix_err nix_set_external	(	nix_c_context *	context,
		Value *	value,
		ExternalValue *	val
	)

Set an external value.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	val	the external value to set. Will be GC-referenced by the value.

Returns: error code, NIX_OK on success.

◆ nix_set_float()

nix_err nix_set_float	(	nix_c_context *	context,
		Value *	value,
		double	d
	)

Set a float.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	d	the float, 64-bits

Returns: error code, NIX_OK on success.

◆ nix_set_int()

nix_err nix_set_int	(	nix_c_context *	context,
		Value *	value,
		int64_t	i
	)

Set an int.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	i	the int

Returns: error code, NIX_OK on success.

◆ nix_set_list_byidx()

nix_err nix_set_list_byidx	(	nix_c_context *	context,
		Value *	value,
		unsigned int	ix,
		Value *	elem
	)

Manipulate a list by index.

Don't do this mid-computation.

Precondition: your list should be at least 'ix+1' items long

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	ix	index to manipulate
[in]	elem	the value to set, will be gc-referenced by the value

Returns: error code, NIX_OK on success.

◆ nix_set_null()

nix_err nix_set_null	(	nix_c_context *	context,
		Value *	value
	)

Set null.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify

Returns: error code, NIX_OK on success.

◆ nix_set_path_string()

nix_err nix_set_path_string	(	nix_c_context *	context,
		Value *	value,
		const char *	str
	)

Set a path.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	str	the path string, copied

Returns: error code, NIX_OK on success.

◆ nix_set_primop()

nix_err nix_set_primop	(	nix_c_context *	context,
		Value *	value,
		PrimOp *	op
	)

Set primop.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	op	primop, will be gc-referenced by the value

See also: nix_alloc_primop

Returns: error code, NIX_OK on success.

◆ nix_set_string()

nix_err nix_set_string	(	nix_c_context *	context,
		Value *	value,
		const char *	str
	)

Set a string.

Parameters

[out]	context	Optional, stores error information
[out]	value	Nix value to modify
[in]	str	the string, copied

Returns: error code, NIX_OK on success.

Typedefs

Functions

Getters

Setters

Detailed Description

Typedef Documentation

◆ BindingsBuilder

Function Documentation

◆ nix_bindings_builder_free()

◆ nix_bindings_builder_insert()

◆ nix_copy_value()

◆ nix_get_attr_byidx()

◆ nix_get_attr_byname()

◆ nix_get_attr_name_byidx()

◆ nix_get_attrs_size()

◆ nix_get_bool()

◆ nix_get_external()

◆ nix_get_float()

◆ nix_get_int()

◆ nix_get_list_byidx()

◆ nix_get_list_size()

◆ nix_get_path_string()

◆ nix_get_string()

◆ nix_get_type()

◆ nix_get_typename()

◆ nix_has_attr_byname()

◆ nix_make_attrs()

◆ nix_make_bindings_builder()

◆ nix_make_list()

◆ nix_set_bool()

◆ nix_set_external()

◆ nix_set_float()

◆ nix_set_int()

◆ nix_set_list_byidx()

◆ nix_set_null()

◆ nix_set_path_string()

◆ nix_set_primop()

◆ nix_set_string()