File: plhashentry.rst

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (42 lines) | stat: -rw-r--r-- 1,075 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
PLHashEntry
===========

.. _plhashentry-syntax:

Syntax
------

.. code::

   #include <plhash.h>

   typedef struct PLHashEntry PLHashEntry;


.. _plhashentry-description:

Description
-----------

``PLHashEntry`` is a structure that represents an entry in the hash
table. An entry has a key and a value, represented by the following
fields in the ``PLHashEntry`` structure.

.. code::

   const void *key;
   void *value;

The key field is a pointer to an opaque key. The value field is a
pointer to an opaque value. If the key of an entry is an integral value
that can fit into a ``void *`` pointer, you can just cast the key itself
to ``void *`` and store it in the key field. Similarly, if the value of
an entry is an integral value that can fit into a ``void *`` pointer,
you can cast the value itself to ``void *`` and store it in the value
field.

.. warning::

   **Warning**: There are other fields in the ``PLHashEntry`` structure
   besides key and value. These fields are for use by the hash table
   library functions and the user should not tamper with them.