Current section

Files

Jump to
cloudi_core doc cloudi_proplists.html
Raw

doc/cloudi_proplists.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_proplists</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_proplists</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="Proplists_Extensions_Module">Proplists Extensions Module</a></h3>.
<p>Copyright © 2009-2018 Michael Truog</p>
<p><b>Version:</b> 1.7.3 Dec 17 2018 18:07:35
------------------------------------------------------------------------</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="Proplists_Extensions_Module">Proplists Extensions Module</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-property">property()</a></h3>
<p><tt>property() = {atom(), 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="#delete_all-2">delete_all/2</a></td><td>
<h4><a name="Delete_all_the_instances_of_the_keys_provided.">Delete all the instances of the keys provided.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#find_any-2">find_any/2</a></td><td>
<h4><a name="Determine_if_any_of_the_keys_provided_are_present.">Determine if any of the keys provided are present.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#partition-2">partition/2</a></td><td>
<h4><a name="Partition_the_proplist_based_on_a_key.">Partition the proplist based on a key.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#take_values-2">take_values/2</a></td><td>
<h4><a name="Remove_many_keys_from_the_proplist.">Remove many keys from the proplist.</a></h4>
The defaults are provided as a proplist.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="delete_all-2">delete_all/2</a></h3>
<div class="spec">
<p><tt>delete_all(Keys::[atom()], List::[<a href="#type-property">property()</a>]) -&gt; [<a href="#type-property">property()</a>]</tt><br></p>
</div><p>
<h4><a name="Delete_all_the_instances_of_the_keys_provided.">Delete all the instances of the keys provided.</a></h4>
</p>
<h3 class="function"><a name="find_any-2">find_any/2</a></h3>
<div class="spec">
<p><tt>find_any(Keys::[atom()], List::[<a href="#type-property">property()</a>]) -&gt; boolean()</tt><br></p>
</div><p>
<h4><a name="Determine_if_any_of_the_keys_provided_are_present.">Determine if any of the keys provided are present.</a></h4>
</p>
<h3 class="function"><a name="partition-2">partition/2</a></h3>
<div class="spec">
<p><tt>partition(Key::atom(), List::[<a href="#type-property">property()</a>]) -&gt; {[<a href="#type-property">property()</a>], [<a href="#type-property">property()</a>]}</tt><br></p>
</div><p>
<h4><a name="Partition_the_proplist_based_on_a_key.">Partition the proplist based on a key.</a></h4>
</p>
<h3 class="function"><a name="take_values-2">take_values/2</a></h3>
<div class="spec">
<p><tt>take_values(DefaultList::[<a href="#type-property">property()</a>], List::[<a href="#type-property">property()</a>]) -&gt; list()</tt><br></p>
</div><p>
<h4><a name="Remove_many_keys_from_the_proplist.">Remove many keys from the proplist.</a></h4>
The defaults are provided as a proplist</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>