keyvalue.h File Reference

mruby/c Key(Symbol) - Value store. More...

#include "value.h"

Include dependency graph for keyvalue.h:

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

Go to the source code of this file.

Data Structures
struct	RKeyValue
	Key-Value data. More...
struct	RKeyValueHandle
	Key-Value handle. More...
struct	RKeyValueIterator
	Key-Value iterator. More...

Macros
#define	MRBC_KVH_INITIALIZER(vm)

Typedefs
typedef struct RKeyValue	mrbc_kv
	Key-Value data.
typedef struct RKeyValueHandle	mrbc_kv_handle
	Key-Value handle.
typedef struct RKeyValueIterator	mrbc_kv_iterator
	Key-Value iterator.

Functions
static int	mrbc_kv_size (const mrbc_kv_handle *kvh)
static mrbc_kv_iterator	mrbc_kv_iterator_new (const mrbc_kv_handle *h)
static int	mrbc_kv_i_is_first (const mrbc_kv_iterator *ite)
static int	mrbc_kv_i_has_next (const mrbc_kv_iterator *ite)
static mrbc_kv *	mrbc_kv_i_get (mrbc_kv_iterator *ite)
static mrbc_kv *	mrbc_kv_i_next (mrbc_kv_iterator *ite)

Detailed Description

mruby/c Key(Symbol) - Value store.

Copyright (C) 2015-      Kyushu Institute of Technology.
Copyright (C) 2015-2026  Shimane IT Open-Innovation Center.
Copyright (C) 2026-      Shimane Institute for Industrial Technology.

This file is distributed under BSD 3-Clause License.

Definition in file keyvalue.h.

Macro Definition Documentation

MRBC_KVH_INITIALIZER

#define MRBC_KVH_INITIALIZER

(

vm

)

Value:

    (mrbc_kv_handle){   \
    .data_size = 0,                                     \
    .n_stored = 0,                                      \
    .vm = vm,                                           \
}

Definition at line 63 of file keyvalue.h.

Typedef Documentation

mrbc_kv

typedef struct RKeyValue mrbc_kv

Key-Value data.

mrbc_kv_handle

typedef struct RKeyValueHandle mrbc_kv_handle

Key-Value handle.

mrbc_kv_iterator

typedef struct RKeyValueIterator mrbc_kv_iterator

Key-Value iterator.

Function Documentation

mrbc_kv_i_get()

mrbc_kv * mrbc_kv_i_get ( mrbc_kv_iterator * ite )

inlinestatic

iterator: getter

Definition at line 151 of file keyvalue.h.

mrbc_kv_i_has_next()

int mrbc_kv_i_has_next ( const mrbc_kv_iterator * ite )

inlinestatic

iterator: has_next?

Definition at line 143 of file keyvalue.h.

Here is the caller graph for this function:

mrbc_kv_i_is_first()

int mrbc_kv_i_is_first ( const mrbc_kv_iterator * ite )

inlinestatic

iterator: is_first?

Definition at line 135 of file keyvalue.h.

Here is the caller graph for this function:

mrbc_kv_i_next()

mrbc_kv * mrbc_kv_i_next ( mrbc_kv_iterator * ite )

inlinestatic

iterator: get and next

Definition at line 159 of file keyvalue.h.

Here is the caller graph for this function:

mrbc_kv_iterator_new()

mrbc_kv_iterator mrbc_kv_iterator_new ( const mrbc_kv_handle * h )

inlinestatic

iterator: constructor

Code example

mrbc_kv_iterator ite = mrbc_kv_iterator_new( kv_handle );
while( mrbc_kv_i_has_next( &ite ) ) {
  const mrbc_kv *kv = mrbc_kv_i_next( &ite );
  // using kv->sym_id and kv->value.
}

Definition at line 122 of file keyvalue.h.

Here is the caller graph for this function:

mrbc_kv_size()

int mrbc_kv_size ( const mrbc_kv_handle * kvh )

inlinestatic

get size

Definition at line 105 of file keyvalue.h.