/builddir/build/BUILD/gru-0.2.0/src/common/gru_keypair.h File Reference

#include <stdint.h>
#include <string.h>
#include "gru_portable.h"
#include "gru_status.h"
#include "gru_variant.h"

Go to the source code of this file.

Data Structures

struct  gru_keypair_t_
 A key/pair structure. More...

Typedefs

typedef struct gru_keypair_t_ gru_keypair_t
 A key/pair structure.

Functions

gru_export gru_keypair_tgru_keypair_new (gru_status_t *status)
 Creates a new key/pair struct.
gru_export void gru_keypair_destroy (gru_keypair_t **ptr)
 Destroys a key/pair struct.
gru_export void gru_keypair_destroy_list_item (void **ptr)
 Destructor wrapper for gru_list_clean.
gru_export bool gru_keypair_set_key (gru_keypair_t *kp, const char *key)
 Sets the key.
gru_export gru_keypair_tgru_keypair_clone (const gru_keypair_t *kp, gru_status_t *status)
 Clone a key/pair struct.
gru_export bool gru_keypair_key_equals (const gru_keypair_t *kp, const char *key)
 Checks whether a key/pair struct matches the key.
gru_export gru_keypair_tgru_keypair_parse (const char *str, gru_status_t *status)
 Parse a string in the format key=pair and returns an gru_keypair_t.

Typedef Documentation

typedef struct gru_keypair_t_ gru_keypair_t

A key/pair structure.


Function Documentation

gru_export gru_keypair_t* gru_keypair_clone ( const gru_keypair_t kp,
gru_status_t status 
)

Clone a key/pair struct.

Parameters:
kp 
status 
Returns:
gru_export void gru_keypair_destroy ( gru_keypair_t **  ptr  ) 

Destroys a key/pair struct.

Parameters:
ptr 
gru_export void gru_keypair_destroy_list_item ( void **  ptr  )  [inline]

Destructor wrapper for gru_list_clean.

Parameters:
ptr 
gru_export bool gru_keypair_key_equals ( const gru_keypair_t kp,
const char *  key 
)

Checks whether a key/pair struct matches the key.

Parameters:
kp 
key 
Returns:
gru_export gru_keypair_t* gru_keypair_new ( gru_status_t status  ) 

Creates a new key/pair struct.

Parameters:
status 
Returns:
gru_export gru_keypair_t* gru_keypair_parse ( const char *  str,
gru_status_t status 
)

Parse a string in the format key=pair and returns an gru_keypair_t.

Parameters:
str 
status 
Returns:
gru_export bool gru_keypair_set_key ( gru_keypair_t kp,
const char *  key 
)

Sets the key.

Parameters:
kp 
key 
Returns:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on 7 Jan 2019 for GRU - Generic Reusable Utilities by  doxygen 1.6.1