Current section
Files
Jump to
Current section
Files
doc/cloudi_key_value.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_key_value</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_key_value</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_Key/Value_Data_Access_for_RequestInfo">CloudI Key/Value Data Access for RequestInfo</a></h3>
Keys are unique in any of the underlying representations.
<p>Copyright © 2014-2017 Michael Truog</p>
<p><b>Version:</b> 1.7.1 May 26 2021 19:42:46
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_Key/Value_Data_Access_for_RequestInfo">CloudI Key/Value Data Access for RequestInfo</a></h3>
Keys are unique in any of the underlying representations.
Used by the cloudi_request_info module.
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-key">key()</a></h3>
<p><tt>key() = binary() | string() | atom()</tt></p>
<h3 class="typedecl"><a name="type-key_values">key_values()</a></h3>
<p><tt>key_values() = <a href="#type-key_values">key_values</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)</tt></p>
<h3 class="typedecl"><a name="type-key_values">key_values()</a></h3>
<p><tt>key_values(Key, Value) = #{Key := Value} | [{Key, Value}] | <a href="dict.html#type-dict">dict:dict</a>(Key, Value)</tt></p>
<h3 class="typedecl"><a name="type-value">value()</a></h3>
<p><tt>value() = binary() | iolist() | any()</tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#erase-2">erase/2</a></td><td>
<h4><a name="Generic_key/value_erase.">Generic key/value erase.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#find-2">find/2</a></td><td>
<h4><a name="Generic_key/value_find.">Generic key/value find.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#store-3">store/3</a></td><td>
<h4><a name="Generic_key/value_store.">Generic key/value store.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#to_dict-1">to_dict/1</a></td><td>
<h4><a name="Generic_key/value_to_dict.">Generic key/value to_dict.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td>
<h4><a name="Generic_key/value_to_list.">Generic key/value to_list.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#to_map-1">to_map/1</a></td><td>
<h4><a name="Generic_key/value_to_map.">Generic key/value to_map.</a></h4>.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="erase-2">erase/2</a></h3>
<div class="spec">
<p><tt>erase(Key::<a href="#type-key">key()</a>, KeyValues::<a href="#type-key_values">key_values()</a>) -> NewKeyValues::<a href="#type-key_values">key_values()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Generic_key/value_erase.">Generic key/value erase.</a></h4>
</p>
<h3 class="function"><a name="find-2">find/2</a></h3>
<div class="spec">
<p><tt>find(Key::<a href="#type-key">key()</a>, KeyValues::<a href="#type-key_values">key_values()</a>) -> {ok, Value::<a href="#type-value">value()</a>} | error</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Generic_key/value_find.">Generic key/value find.</a></h4>
</p>
<h3 class="function"><a name="store-3">store/3</a></h3>
<div class="spec">
<p><tt>store(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, KeyValues::<a href="#type-key_values">key_values()</a>) -> NewKeyValues::<a href="#type-key_values">key_values()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Generic_key/value_store.">Generic key/value store.</a></h4>
</p>
<h3 class="function"><a name="to_dict-1">to_dict/1</a></h3>
<div class="spec">
<p><tt>to_dict(KeyValues::<a href="#type-key_values">key_values()</a>) -> <a href="dict.html#type-dict">dict:dict</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Generic_key/value_to_dict.">Generic key/value to_dict.</a></h4>
</p>
<h3 class="function"><a name="to_list-1">to_list/1</a></h3>
<div class="spec">
<p><tt>to_list(KeyValues::<a href="#type-key_values">key_values()</a>) -> [{<a href="#type-key">key()</a>, <a href="#type-value">value()</a>}]</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Generic_key/value_to_list.">Generic key/value to_list.</a></h4>
</p>
<h3 class="function"><a name="to_map-1">to_map/1</a></h3>
<div class="spec">
<p><tt>to_map(KeyValues::<a href="#type-key_values">key_values()</a>) -> #{<a href="#type-key">key()</a> := <a href="#type-value">value()</a>}</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Generic_key/value_to_map.">Generic key/value to_map.</a></h4>
</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>