Packages

riak

1.1.4
1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0

A Riak client written in Elixir.

HexDocs

Current section

Files

Jump to
Readme
8 Versions
3 Dependencies
1 Dependant
Files
Activity
riak doc Riak.CRDT.Set.html
Raw

doc/Riak.CRDT.Set.html 

    <!DOCTYPE html>

<html>

  <head>

    <meta charset="utf-8">

    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>Riak.CRDT.Set – Riak Elixir Client v1.1.4</title>

    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta name="generator" content="ExDoc v0.10.0">

    <link rel="stylesheet" href="dist/app.css" />

    <script src="dist/sidebar_items.js"></script>

  </head>

  <body data-type="modules">



    <div class="main">

<button class="sidebar-toggle">

  <i class="icon-menu"></i>

</button>

<section class="sidebar">

  <button class="sidebar-toggle">

    <i class="icon-menu"></i>

  </button>



  

  <a href="extra-api-reference.html" class="sidebar-projectLink">

    <div class="sidebar-projectDetails">

      <h1 class="sidebar-projectName">

        Riak Elixir Client

      </h1>

      <h2 class="sidebar-projectVersion">

        v1.1.4

      </h2>

    </div>

    

  </a>



  <div class="sidebar-search">

    <i class="icon-search"></i>

    <input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />

  </div>



  <ul class="sidebar-listNav">

    <li><a id="extras-list" href="#full-list">Pages</a></li>



    

      <li><a id="modules-list" href="#full-list">Modules</a></li>

    



    



    

  </ul>



  <ul id="full-list" class="sidebar-fullList"></ul>

  <div class="sidebar-noResults"></div>

</section>



<section class="content">

  <div id="content" class="content-inner">





      <h1>

        Riak.CRDT.Set

        

        

          <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L1" title="View Source" class="view-source" rel="help">

            <i class="icon-code"></i>

          </a>

        

      </h1>



      

        <section id="moduledoc" class="docstring">

          <p>Encapsulates riakc_set using elixir Set functions as interface.

It accepts only binary as items.</p>



        </section>

      



      

        <section id="summary" class="details-list">

          <h1 class="section-heading">

            <a class="hover-link" href="#summary">

              <i class="icon-link"></i>

            </a>

            Summary

          </h1>

          



          

  <div class="summary-functions summary">

    <h2>

      <a href="#functions">Functions</a>

    </h2>

    <div class="summary-row">

  <div class="summary-signature">

    <a href="#delete/2">delete(set, value)</a>

  </div>

  

    <div class="summary-synopsis"><p>Delete <code class="inline">value</code> on <code class="inline">set</code></p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#member?/2">member?(set, value)</a>

  </div>

  

    <div class="summary-synopsis"><p>Checks if <code class="inline">set</code> contains <code class="inline">value</code></p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#new/0">new()</a>

  </div>

  

    <div class="summary-synopsis"><p>Create an empty set</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#new/1">new(context)</a>

  </div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#new/2">new(value, context)</a>

  </div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#put/2">put(set, value)</a>

  </div>

  

    <div class="summary-synopsis"><p>Insert <code class="inline">value</code> on <code class="inline">set</code></p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#size/1">size(set)</a>

  </div>

  

    <div class="summary-synopsis"><p>Returns the number of elements in <code class="inline">set</code></p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#value/1">value(set)</a>

  </div>

  

    <div class="summary-synopsis"><p>Get original value as an <code class="inline">ordset</code></p>

</div>

  

</div>



  </div>





          



          



        </section>

      



      



      

        <section id="functions" class="details-list">

          <h1 class="section-heading">

            <a class="hover-link" href="#functions">

              <i class="icon-link"></i>

            </a>

            Functions

          </h1>

          <div class="detail" id="delete/2">

  <div class="detail-header">

    <a href="#delete/2" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">delete(set, value)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L45" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    <p>Delete <code class="inline">value</code> on <code class="inline">set</code></p>



  </section>

</div>

<div class="detail" id="member?/2">

  <div class="detail-header">

    <a href="#member?/2" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">member?(set, value)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L27" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    <p>Checks if <code class="inline">set</code> contains <code class="inline">value</code>.</p>



  </section>

</div>

<div class="detail" id="new/0">

  <div class="detail-header">

    <a href="#new/0" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">new()</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L11" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    <p>Create an empty set</p>



  </section>

</div>

<div class="detail" id="new/1">

  <div class="detail-header">

    <a href="#new/1" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">new(context)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L12" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    

  </section>

</div>

<div class="detail" id="new/2">

  <div class="detail-header">

    <a href="#new/2" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">new(value, context)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L13" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    

  </section>

</div>

<div class="detail" id="put/2">

  <div class="detail-header">

    <a href="#put/2" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">put(set, value)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L36" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    <p>Insert <code class="inline">value</code> on <code class="inline">set</code></p>



  </section>

</div>

<div class="detail" id="size/1">

  <div class="detail-header">

    <a href="#size/1" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">size(set)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L54" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    <p>Returns the number of elements in <code class="inline">set</code></p>



  </section>

</div>

<div class="detail" id="value/1">

  <div class="detail-header">

    <a href="#value/1" class="detail-link" title="Link to this function">

      <i class="icon-link"></i>

    </a>

    <span class="signature">value(set)</span>

      

      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/set.ex#L18" class="view-source" rel="help" title="View Source">

       <i class="icon-code"></i>

     </a>

    

  </div>

  

  <section class="docstring">

    <p>Get original value as an <code class="inline">ordset</code></p>



  </section>

</div>



        </section>

      



      



      

        <footer class="footer">

      <p>

        <span class="line">

          Built using

          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.10.0),

        </span>

        <span class="line">

          designed by

          <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.

          </span>

      </p>

    </footer>

  </div>

</section>

</div>

    <script src="dist/app.js"></script>

  </body>

</html>