# Module cloudi_key_value

- Description
- Data Types
- Function Index
- Function Details

### CloudI Key/Value Data Access for RequestInfo

Keys are unique in any of the underlying representations.

Copyright © 2014-2017 Michael Truog

Version: 1.7.1 Dec 3 2021 17:15:33 ------------------------------------------------------------------------

Authors: Michael Truog (`mjtruog at protonmail dot com`).

## Description

### CloudI Key/Value Data Access for RequestInfo

Keys are unique in any of the underlying representations. Used by the cloudi_request_info module.

## Data Types

### key()

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

### key_values()

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

### key_values()

`key_values(Key, Value) = #{Key := Value} | [{Key, Value}] | dict:dict(Key, Value)`

### value()

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

## Function Index

erase/2 | #### Generic key/value erase. .
find/2 | #### Generic key/value find. .
store/3 | #### Generic key/value store. .
to_dict/1 | #### Generic key/value to_dict. .
to_list/1 | #### Generic key/value to_list. .
to_map/1 | #### Generic key/value to_map. .

## Function Details

### erase/2

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

#### Generic key/value erase.

### find/2

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

#### Generic key/value find.

### store/3

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

#### Generic key/value store.

### to_dict/1

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

#### Generic key/value to_dict.

### to_list/1

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

#### Generic key/value to_list.

### to_map/1

`to_map(KeyValues::key_values()) -> #{key() := value()}`

#### Generic key/value to_map.

Generated by EDoc