_Key Struct Reference
[Elektra framework for pluggable backends]

The private Key struct. More...

Data Fields
uint8_t	type
	Type of the value, from KeyType.
uid_t	uid
	System UID of this key.
uid_t	gid
	System GID of this key.
mode_t	access
	File-like access control.
time_t	atime
	Time for last access (stat).
time_t	mtime
	Time for last modification.
time_t	ctime
	Time for last change (meta info).
size_t	commentSize
	Size of the comment of description string, including ending NULL.
size_t	dataSize
	Size of the value, in bytes, including ending NULL.
size_t	recordSize
	dataSize + commentSize + some control
uint32_t	flags
	Some control and internal flags.
char *	key
	The name of the key.
char *	comment
	A comment about the key.
char *	userDomain
	The user that owns the key.
void *	data
	The value, which is a NULL terminated string or binary.
_Key *	next
	Link to the next object in a KeySet context.

---

Detailed Description

The private Key struct.

Its internal private attributes should not be accessed directly by regular programs. Use the Key access methods instead. Only a backend writer needs to have access to the private attributes of the Key object which is defined as:

typedef struct _Key Key;

Definition at line 82 of file kdbprivate.h.

---

Field Documentation

uint8_t _Key::type

Type of the value, from KeyType. See also: keyGetType(), keySetType(), keyIsBin() Definition at line 87 of file kdbprivate.h. Referenced by keyCompare(), keyGetLink(), keyGetString(), keyGetType(), keyInit(), keyIsBin(), keyIsDir(), keyIsLink(), keyIsString(), keySetType(), keyToStreamBasename(), ksLookupByValue(), and ksLookupRE().

uid_t _Key::uid

System UID of this key. See also: keyGetUID(), keySetUID() Definition at line 93 of file kdbprivate.h. Referenced by keyCompare(), keyGetUID(), keyInit(), keySetUID(), and keyToStreamBasename().

uid_t _Key::gid

System GID of this key. See also: keyGetGID(), keySetGID() Definition at line 99 of file kdbprivate.h. Referenced by keyCompare(), keyGetGID(), keyInit(), keySetGID(), and keyToStreamBasename().

mode_t _Key::access

File-like access control. See also: keyGetAccess(), keySetAccess() Definition at line 105 of file kdbprivate.h. Referenced by keyCompare(), keyGetAccess(), keyInit(), keySetAccess(), keySetType(), and keyToStreamBasename().

time_t _Key::atime

Time for last access (stat). See also: keyGetATime() Definition at line 111 of file kdbprivate.h. Referenced by keyGetATime().

time_t _Key::mtime

Time for last modification. See also: keyGetMTime() Definition at line 117 of file kdbprivate.h. Referenced by keyGetMTime().

time_t _Key::ctime

Time for last change (meta info). See also: keyGetCTime() Definition at line 123 of file kdbprivate.h. Referenced by keyGetCTime().

size_t _Key::commentSize

Size of the comment of description string, including ending NULL. See also: keyGetCommentSize(), keySetComment(), keyGetComment() Definition at line 129 of file kdbprivate.h. Referenced by keySetComment().

size_t _Key::dataSize

Size of the value, in bytes, including ending NULL. See also: keyGetCommentSize(), keySetComment(), keyGetComment() Definition at line 135 of file kdbprivate.h. Referenced by keyCompare(), keyDup(), keyGetBinary(), keyGetLink(), keyGetString(), keyGetValueSize(), keySetRaw(), keyToStreamBasename(), ksLookupByBinaryValue(), and ksLookupByValue().

uint32_t _Key::flags

Some control and internal flags. See also: keySetFlag(), keyGetFlag() Definition at line 142 of file kdbprivate.h. Referenced by kdbGetRootKeys(), keyClearFlag(), keyCompare(), keyDup(), keyGetFlag(), keyGetNamespace(), keyInit(), keyIsInitialized(), keyIsSystem(), keyIsUser(), keyNeedsSync(), keyNew(), keySetAccess(), keySetComment(), keySetFlag(), keySetGID(), keySetName(), keySetOwner(), keySetRaw(), keySetType(), and keySetUID().

char* _Key::key

The name of the key. See also: keySetName(), keyGetName() Definition at line 148 of file kdbprivate.h. Referenced by keyAddBaseName(), keyClose(), keyCompare(), keyDup(), keyGetBaseName(), keyGetBaseNameSize(), keyGetFullName(), keyGetFullNameSize(), keyGetFullRootName(), keyGetFullRootNameSize(), keyGetName(), keyGetNameSize(), keyGetParentName(), keyGetParentNameSize(), keyGetRootName(), keyGetRootNameSize(), keySetBaseName(), keySetName(), keyStealBaseName(), keyStealName(), keyToStreamBasename(), ksLookupByName(), ksLookupRE(), and ksToStream().

char* _Key::comment

A comment about the key. See also: keySetComment(), keyGetComment() Definition at line 154 of file kdbprivate.h. Referenced by keyClose(), keyCompare(), keyDup(), keyGetComment(), keyGetCommentSize(), keySetComment(), keyStealComment(), keyToStreamBasename(), and ksLookupRE().

char* _Key::userDomain

The user that owns the key. See also: keySetComment(), keyGetComment() Definition at line 160 of file kdbprivate.h. Referenced by keyClose(), keyCompare(), keyDup(), keyGetFullName(), keyGetFullNameSize(), keyGetFullRootName(), keyGetFullRootNameSize(), keyGetOwner(), keyGetOwnerSize(), keySetName(), keySetOwner(), keyStealOwner(), keyToStreamBasename(), and ksLookupRE().

void* _Key::data

The value, which is a NULL terminated string or binary. See also: keySetString(), keyGetString() Definition at line 166 of file kdbprivate.h. Referenced by keyClose(), keyCompare(), keyDup(), keyGetBinary(), keyGetLink(), keyGetString(), keySetRaw(), keyStealValue(), keyToStreamBasename(), ksLookupByBinaryValue(), ksLookupByValue(), and ksLookupRE().

---

The documentation for this struct was generated from the following file:

• kdbprivate.h

---