lib.h File Reference

Key value store. More...

#include <stdbool.h>
#include <stdlib.h>

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	StoreOps

Macros
#define	STORE_BACKEND_OPS(_name)

Typedefs
typedef void	StoreHandle
	Opaque type for store backend.

Functions
struct Slist *	store_backend_list (void)
	Get a list of backend names.
const struct StoreOps *	store_get_backend_ops (const char *str)
	Get the API functions for an store backend.
bool	store_is_valid_backend (const char *str)
	Is the string a valid Store backend.

Detailed Description

Key value store.

Authors

• Pietro Cerutti
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Macro Definition Documentation

STORE_BACKEND_OPS

#define STORE_BACKEND_OPS

(

_name

)

Value:

  const struct StoreOps store_##_name##_ops = {                                \
    .name           = #_name,                                                  \
    .open           = store_##_name##_open,                                    \
    .fetch          = store_##_name##_fetch,                                   \
    .free           = store_##_name##_free,                                    \
    .store          = store_##_name##_store,                                   \
    .delete_record  = store_##_name##_delete_record,                           \
    .close          = store_##_name##_close,                                   \
    .version        = store_##_name##_version,                                 \
  };

Definition at line 160 of file lib.h.

#define STORE_BACKEND_OPS(_name)                                               \
  const struct StoreOps store_##_name##_ops = {                                \
    .name           = #_name,                                                  \
    .open           = store_##_name##_open,                                    \
    .fetch          = store_##_name##_fetch,                                   \
    .free           = store_##_name##_free,                                    \
    .store          = store_##_name##_store,                                   \
    .delete_record  = store_##_name##_delete_record,                           \
    .close          = store_##_name##_close,                                   \
    .version        = store_##_name##_version,                                 \
  };

Typedef Documentation

StoreHandle

typedef void StoreHandle

Opaque type for store backend.

Definition at line 58 of file lib.h.

Function Documentation

store_backend_list()

struct Slist * store_backend_list

(

void

)

Get a list of backend names.

Return values

ptr	List of names

Note

Caller should free the Slist

Definition at line 69 of file store.c.

{
  struct Slist *sl = slist_new(D_SLIST_SEP_SPACE);
 
  const struct StoreOps **store_ops = StoreOps;
 
  for (; *store_ops; store_ops++)
  {
    slist_add_string(sl, (*store_ops)->name);
  }
 
  return sl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

store_get_backend_ops()

const struct StoreOps * store_get_backend_ops

(

const char *

str

)

Get the API functions for an store backend.

Parameters

str	Name of the Store

Return values

ptr	Set of function pointers

Definition at line 88 of file store.c.

{
  const struct StoreOps **store_ops = StoreOps;
 
  if (!str || (*str == '\0'))
  {
    return *store_ops;
  }
 
  for (; *store_ops; store_ops++)
    if (mutt_str_equal(str, (*store_ops)->name))
      return *store_ops;
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

store_is_valid_backend()

bool store_is_valid_backend

(

const char *

str

)

Is the string a valid Store backend.

Parameters

str	Store name

Return values

true	s is recognized as a valid backend
false	otherwise

Definition at line 110 of file store.c.

{
  return store_get_backend_ops(str);
}

Here is the call graph for this function:

Here is the caller graph for this function: