davide carboni / Mbed 2 deprecated pymite_http_get

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

dict.c File Reference

dict.c File Reference

Dict Object Type. More...

Go to the source code of this file.

Functions

PmReturn_t dict_new (pPmObj_t *r_pdict)
 Allocates space for a new Dict.
PmReturn_t dict_clear (pPmObj_t pdict)
 Clears the contents of a dict.
PmReturn_t dict_setItem (pPmObj_t pdict, pPmObj_t pkey, pPmObj_t pval)
 Sets a value in the dict using the given key.
PmReturn_t dict_getItem (pPmObj_t pdict, pPmObj_t pkey, pPmObj_t *r_pobj)
 Gets the value in the dict using the given key.
PmReturn_t dict_delItem (pPmObj_t pdict, pPmObj_t pkey)
 Removes a key and value from the dict.
PmReturn_t dict_print (pPmObj_t pdict)
 Prints out a dict.
PmReturn_t dict_update (pPmObj_t pdestdict, pPmObj_t psourcedict)
 Updates the destination dict with the key,value pairs from the source dict.

Detailed Description

Dict Object Type.

Dict object type operations.

Definition in file dict.c.


Function Documentation

PmReturn_t dict_clear ( pPmObj_t  pdict )

Clears the contents of a dict.

after this operation, the dict should in the same state as if it were just created using dict_new().

Parameters:
pdictptr to dict to clear.
Returns:
nothing

Definition at line 55 of file dict.c.

PmReturn_t dict_delItem ( pPmObj_t  pdict,
pPmObj_t  pkey 
)

Removes a key and value from the dict.

Throws TypeError if pdict is not a dict. Throws KeyError if pkey does not exist in pdict.

Parameters:
pdictPtr to dict to search
pkeyPtr to key obj
Returns:
Return status

Definition at line 215 of file dict.c.

PmReturn_t dict_getItem ( pPmObj_t  pdict,
pPmObj_t  pkey,
pPmObj_t r_pobj 
)

Gets the value in the dict using the given key.

Parameters:
pdictptr to dict to search
pkeyptr to key obj
r_pobjReturn; addr of ptr to obj
Returns:
Return status

Definition at line 166 of file dict.c.

PmReturn_t dict_new ( pPmObj_t r_pdict )

Allocates space for a new Dict.

Return a pointer to the dict by reference.

Parameters:
r_pdictReturn; Addr of ptr to dict
Returns:
Return status

Definition at line 32 of file dict.c.

PmReturn_t dict_print ( pPmObj_t  pdict )

Prints out a dict.

Uses obj_print() to print elements.

Parameters:
pobjObject to print.
Returns:
Return status

Definition at line 249 of file dict.c.

PmReturn_t dict_setItem ( pPmObj_t  pdict,
pPmObj_t  pkey,
pPmObj_t  pval 
)

Sets a value in the dict using the given key.

If the dict already contains a matching key, the value is replaced; otherwise the new key,val pair is inserted at the front of the dict (for fast lookup). In the later case, the length of the dict is incremented.

Parameters:
pdictptr to dict in which (key,val) will go
pkeyptr to key obj
pvalptr to val obj
Returns:
Return status

Definition at line 96 of file dict.c.

PmReturn_t dict_update ( pPmObj_t  pdestdict,
pPmObj_t  psourcedict 
)

Updates the destination dict with the key,value pairs from the source dict.

Parameters:
pdestdictptr to destination dict in which key,val pairs will go
psourcedictptr to source dict which has all key,val pairs to copy
Returns:
Return status

Definition at line 296 of file dict.c.