keyset.c File Reference

Methods for key sets. More...

#include <kdbtypes.h>
#include "kdbinternal.h"
#include <kdbassert.h>
#include <kdbrand.h>

Include dependency graph for keyset.c:

Functions
KeySet *	ksNew (size_t alloc,...)
	Allocate, initialize and return a new KeySet object.
KeySet *	ksVNew (size_t alloc, va_list va)
	Allocate, initialize and return a new KeySet object.
KeySet *	ksDup (const KeySet *source)
	Return a duplicate of a keyset.
int	ksCopy (KeySet *dest, const KeySet *source)
	Replace the content of a keyset with another one.
int	ksDel (KeySet *ks)
	A destructor for KeySet objects.
int	keyCmp (const Key *k1, const Key *k2)
	Compare the name of two keys.
int	ksNeedSync (const KeySet *ks)
	Checks if KeySet needs sync.
ssize_t	ksGetSize (const KeySet *ks)
	Return the number of keys that ks contains.
ssize_t	ksAppendKey (KeySet *ks, Key *toAppend)
	Appends a Key to the end of ks.
ssize_t	ksAppend (KeySet *ks, const KeySet *toAppend)
	Append all toAppend contained keys to the end of the ks.
KeySet *	ksCut (KeySet *ks, const Key *cutpoint)
	Cuts out a keyset at the cutpoint.
Key *	ksPop (KeySet *ks)
	Remove and return the last key of ks.
int	ksRewind (KeySet *ks)
	Rewinds the KeySet internal cursor.
Key *	ksNext (KeySet *ks)
	Returns the next Key in a KeySet.
Key *	ksCurrent (const KeySet *ks)
	Return the current Key.
Key *	ksHead (const KeySet *ks)
	Return the first key in the KeySet.
Key *	ksTail (const KeySet *ks)
	Return the last key in the KeySet.
cursor_t	ksGetCursor (const KeySet *ks)
	Get the KeySet internal cursor.
Key *	ksAtCursor (KeySet *ks, cursor_t pos)
	return key at given cursor position
int	ksSetCursor (KeySet *ks, cursor_t cursor)
	Set the KeySet internal cursor.
Key *	ksLookup (KeySet *ks, Key *key, option_t options)
	Look for a Key contained in ks that matches the name of the key.
Key *	ksLookupByName (KeySet *ks, const char *name, option_t options)
	Convenience method to look for a Key contained in ks that matches name.

Detailed Description

Methods for key sets.

Copyright

BSD License (see LICENSE.md or https://www.libelektra.org)