GRU - Generic Reusable Utilities
Loading...
Searching...
No Matches
Data Structures | Typedefs | Functions
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. More...
 

Functions

gru_export gru_keypair_tgru_keypair_new (gru_status_t *status)
 Creates a new key/pair struct. More...
 
gru_export void gru_keypair_destroy (gru_keypair_t **ptr)
 Destroys a key/pair struct. More...
 
gru_export void gru_keypair_destroy_list_item (void **ptr)
 Destructor wrapper for gru_list_clean. More...
 
gru_export bool gru_keypair_set_key (gru_keypair_t *kp, const char *key)
 Sets the key. More...
 
gru_export gru_keypair_tgru_keypair_clone (const gru_keypair_t *kp, gru_status_t *status)
 Clone a key/pair struct. More...
 
gru_export bool gru_keypair_key_equals (const gru_keypair_t *kp, const char *key)
 Checks whether a key/pair struct matches the key. More...
 
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. More...
 

Typedef Documentation

◆ gru_keypair_t

typedef struct gru_keypair_t_ gru_keypair_t

A key/pair structure.

Function Documentation

◆ gru_keypair_clone()

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_keypair_destroy()

gru_export void gru_keypair_destroy ( gru_keypair_t **  ptr)

Destroys a key/pair struct.

Parameters
ptr

◆ gru_keypair_destroy_list_item()

gru_export void gru_keypair_destroy_list_item ( void **  ptr)
inline

Destructor wrapper for gru_list_clean.

Parameters
ptr

◆ gru_keypair_key_equals()

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_keypair_new()

gru_export gru_keypair_t * gru_keypair_new ( gru_status_t status)

Creates a new key/pair struct.

Parameters
status
Returns

◆ gru_keypair_parse()

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_keypair_set_key()

gru_export bool gru_keypair_set_key ( gru_keypair_t kp,
const char *  key 
)

Sets the key.

Parameters
kp
key
Returns