# Module cloudi_key_value

- Description
- Data Types
- Function Index
- Function Details

### CloudI Key/Value Data Access for RequestInfo

Keys are unique in both the list and dict key_values data result.

Copyright © 2014-2015 Michael Truog

Version: 1.5.1 Mar 28 2017 19:21:38 ------------------------------------------------------------------------

Authors: Michael Truog (`mjtruog [at] gmail (dot) com`).

## Description

### CloudI Key/Value Data Access for RequestInfo

Keys are unique in both the list and dict key_values data result.

## Data Types

### dict_proxy()

`dict_proxy(Key, Value) = dict:dict(Key, Value)`

### key()

`key() = binary() | string() | atom()`

### key_values()

`key_values() = key_values(key(), value())`

### key_values()

`key_values(Key, Value) = [{Key, Value}] | dict_proxy(Key, Value)`

### value()

`value() = binary() | iolist() | any()`

## Function Index

erase/2 | #### Generic key/value erase. RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to erase request meta-data while encapsulating the data structure used for the lookup.
find/2 | #### Generic key/value find. RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to access the request meta-data while encapsulating the data structure used for the lookup.
store/3 | #### Generic key/value store. RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to store request meta-data while encapsulating the data structure used for the lookup.
to_dict/1 | #### Generic key/value to_dict. RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to erase request meta-data while encapsulating the data structure used for the lookup.
to_list/1 | #### Generic key/value to_list. RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to erase request meta-data while encapsulating the data structure used for the lookup.

## Function Details

### erase/2

`erase(Key::key(), KeyValues::key_values()) -> NewKeyValues::key_values()`

#### Generic key/value erase.

RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to erase request meta-data while encapsulating the data structure used for the lookup.

### find/2

`find(Key::key(), KeyValues::key_values()) -> {ok, Value::value()} | error`

#### Generic key/value find.

RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to access the request meta-data while encapsulating the data structure used for the lookup.

### store/3

`store(Key::key(), Value::value(), KeyValues::key_values()) -> NewKeyValues::key_values()`

#### Generic key/value store.

RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to store request meta-data while encapsulating the data structure used for the lookup.

### to_dict/1

`to_dict(KeyValues::key_values()) -> dict_proxy(key(), value())`

#### Generic key/value to_dict.

RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to erase request meta-data while encapsulating the data structure used for the lookup.

### to_list/1

`to_list(KeyValues::key_values()) -> [{key(), value()}]`

#### Generic key/value to_list.

RequestInfo's key/value result from request_info_key_value_parse/1 can be used here to erase request meta-data while encapsulating the data structure used for the lookup.

Generated by EDoc, Mar 28 2017, 19:21:38.