_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 user that owns the key. The value, which is a NULL terminated string or binary.
_Keynext
 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 87 of file kdbprivate.h.


Field Documentation

uint8_t _Key::type

Type of the value, from KeyType.

See also:
keyGetType(), keySetType(), keyIsBin()

Definition at line 92 of file kdbprivate.h.

Referenced by keyCompare(), keyGetLink(), keyGetString(), keyGetType(), keyInit(), keyIsBin(), keyIsLink(), keyIsString(), keySetType(), keyToStreamBasename(), ksLookupByValue(), and ksLookupRE().

uid_t _Key::uid

System UID of this key.

See also:
keyGetUID(), keySetUID()

Definition at line 98 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 104 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 110 of file kdbprivate.h.

Referenced by keyCompare(), keyGetAccess(), keyIsDir(), keySetAccess(), keySetDir(), keySetUAccess(), and keyToStreamBasename().

time_t _Key::atime

Time for last access (stat).

See also:
keyGetATime()

Definition at line 116 of file kdbprivate.h.

Referenced by keyGetATime().

time_t _Key::mtime

Time for last modification.

See also:
keyGetMTime()

Definition at line 122 of file kdbprivate.h.

Referenced by keyGetMTime().

time_t _Key::ctime

Time for last change (meta info).

See also:
keyGetCTime()

Definition at line 128 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 134 of file kdbprivate.h.

Referenced by keySerialize(), keySetComment(), and keyUnserialize().

size_t _Key::dataSize

Size of the value, in bytes, including ending NULL.

See also:
keyGetCommentSize(), keySetComment(), keyGetComment()

Definition at line 140 of file kdbprivate.h.

Referenced by keyCompare(), keyDup(), keyGetBinary(), keyGetLink(), keyGetString(), keyGetValueSize(), keySerialize(), keySetRaw(), keyToStreamBasename(), keyUnserialize(), ksLookupByBinaryValue(), and ksLookupByValue().

uint32_t _Key::flags

Some control and internal flags.

See also:
keySetFlag(), keyGetFlag()

Definition at line 147 of file kdbprivate.h.

Referenced by kdbGetRootKeys(), keyClearFlag(), keyCompare(), keyDup(), keyGetFlag(), keyGetNamespace(), keyInit(), keyIsInitialized(), keyIsSystem(), keyIsUser(), keyNeedsSync(), keySetAccess(), keySetComment(), keySetDir(), keySetFlag(), keySetGID(), keySetName(), keySetOwner(), keySetRaw(), keySetType(), keySetUAccess(), and keySetUID().

char* _Key::key

The name of the key.

See also:
keySetName(), keyGetName()

Definition at line 153 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(), ksGetCommonParentName(), ksLookupByName(), and ksLookupRE().

char* _Key::comment

A comment about the key.

See also:
keySetComment(), keyGetComment()

Definition at line 159 of file kdbprivate.h.

Referenced by keyClose(), keyCompare(), keyDup(), keyGetComment(), keyGetCommentSize(), keySerialize(), keySetComment(), keyStealComment(), keyToStreamBasename(), keyUnserialize(), and ksLookupRE().

char* _Key::userDomain

The user that owns the key.

See also:
keySetComment(), keyGetComment()

Definition at line 165 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 user that owns the key. The value, which is a NULL terminated string or binary.

See also:
keySetString(), keyGetString()

Definition at line 171 of file kdbprivate.h.

Referenced by keyClose(), keyCompare(), keyDup(), keyGetBinary(), keyGetLink(), keyGetString(), keySerialize(), keySetRaw(), keyStealValue(), keyToStreamBasename(), keyUnserialize(), ksLookupByBinaryValue(), ksLookupByValue(), and ksLookupRE().


The documentation for this struct was generated from the following file:
Generated on Sun Mar 25 21:33:37 2007 for Elektra Project by  doxygen 1.5.1