Packages

binary_reader

0.1.0
0.1.0

A Elixir Binary Reader that running WITH side effects.

HexDocs

Current section

Files

Jump to
Readme
1 Version
0 Dependencies
Dependants
Files
Activity
binary_reader doc BinaryReader.html
Raw

doc/BinaryReader.html 

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="utf-8">

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

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

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

    <meta name="project" content="binary_reader v0.1.0">

    <title>BinaryReader — binary_reader v0.1.0</title>

    <link rel="stylesheet" href="dist/elixir-d678dad126d82ddc061f.css" />

      <link rel="canonical" href="https://hexdocs.pm/binary_reader/BinaryReader.html" />

    <script src="dist/sidebar_items-739881f7e4.js"></script>

      <script src="docs_config.js"></script>

    <script async src="dist/app-0103364119015b97e56c.js"></script>

  </head>

  <body data-type="modules">

    <script>try { if(localStorage.getItem('night-mode') === 'true') document.body.className += ' night-mode'; } catch (e) { }</script>

<div class="main">



<button class="sidebar-button sidebar-toggle">

  <span class="icon-menu" title="Collapse/expand sidebar"></span>

</button>



<section class="sidebar">

  <form class="sidebar-search" action="search.html">

    <button type="submit" class="search-button">

      <span class="icon-search" aria-hidden="true"></span>

    </button>

    <button type="button" tabindex="-1" class="search-close-button">

      <span class="icon-cross" title="Cancel search"></span>

    </button>

    <label class="search-label">

      <input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />

    </label>

  </form>



  <div class="autocomplete">

    <div class="autocomplete-results">

    </div>

  </div>



  <div class="sidebar-header">

    <div class="sidebar-projectDetails">

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

binary_reader      </a>

      <h2 class="sidebar-projectVersion">

        v0.1.0

      </h2>

    </div>

  </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>

  <div class="gradient"></div>

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

</section>



<section class="content">

  <div class="content-outer">

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



      <h1>

        <small class="app-vsn">binary_reader v0.1.0</small>

BinaryReader      </h1>





        <section id="moduledoc">

<p>Warning: This module has side effects.</p><p>a_int = BinaryReader.read_int32(pid)</p><p>Each action like this will cost a side effect, chaging the binary content that inputed initailly.

Be careful to use it according to your needs.</p>        </section>



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

          <h1 class="section-heading">

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

              <span class="icon-link" aria-hidden="true"></span>

              <span class="sr-only">Link to this section</span>

            </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="#move_pivot_to/2">move_pivot_to(pid, index)</a>

  </div>

    <div class="summary-synopsis"><p>Move the reading pivot to certain index</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#read_byte/1">read_byte(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Read one byte</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#read_bytes/2">read_bytes(pid, size)</a>

  </div>

    <div class="summary-synopsis"><p>Read number of bytes</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#read_int16/1">read_int16(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Read 2 bytes for int16</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#read_int32/1">read_int32(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Read 4 bytes for int32</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#read_int64/1">read_int64(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Read 8 bytes for int64</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#read_string/1">read_string(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Read 4 bytes for string</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#remains_byte_size/1">remains_byte_size(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Return remains size of bytes</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#start_link/1">start_link(content)</a>

  </div>

    <div class="summary-synopsis"><p>Start the GenServer</p></div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#stop/1">stop(pid)</a>

  </div>

    <div class="summary-synopsis"><p>Stop the GenServer</p></div>

</div>

  </div>

        </section>



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

          <h1 class="section-heading">

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

              <span class="icon-link" aria-hidden="true"></span>

              <span class="sr-only">Link to this section</span>

            </a>

Functions          </h1>

          <div class="functions-list">

<section class="detail" id="move_pivot_to/2">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">move_pivot_to(pid, index)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>move_pivot_to(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) :: :ok</pre>

      </div>



<p>Move the reading pivot to certain index</p>  </section>

</section>

<section class="detail" id="read_byte/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">read_byte(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>read_byte(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()</pre>

      </div>



<p>Read one byte</p>  </section>

</section>

<section class="detail" id="read_bytes/2">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">read_bytes(pid, size)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>read_bytes(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()</pre>

      </div>



<p>Read number of bytes</p>  </section>

</section>

<section class="detail" id="read_int16/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">read_int16(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>read_int16(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()</pre>

      </div>



<p>Read 2 bytes for int16</p>  </section>

</section>

<section class="detail" id="read_int32/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">read_int32(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>read_int32(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()</pre>

      </div>



<p>Read 4 bytes for int32</p>  </section>

</section>

<section class="detail" id="read_int64/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">read_int64(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>read_int64(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()</pre>

      </div>



<p>Read 8 bytes for int64</p>  </section>

</section>

<section class="detail" id="read_string/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">read_string(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>read_string(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre>

      </div>



<p>Read 4 bytes for string</p>  </section>

</section>

<section class="detail" id="remains_byte_size/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">remains_byte_size(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>remains_byte_size(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()</pre>

      </div>



<p>Return remains size of bytes</p>  </section>

</section>

<section class="detail" id="start_link/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">start_link(content)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>start_link(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()}</pre>

      </div>



<p>Start the GenServer</p>  </section>

</section>

<section class="detail" id="stop/1">

  <div class="detail-header">

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

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature">stop(pid)</h1>

  </div>



  <section class="docstring">

      <h2>Specs</h2>

      <div class="specs">

          <pre>stop(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: :ok</pre>

      </div>



<p>Stop the GenServer</p>  </section>

</section>

          </div>

        </section>

      <footer class="footer">

        <p>

          <span class="line">

            Built using

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

          </span>

          <span class="line">

            designed by

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

          </span>

        </p>

        <p>

          <button class="line footer-button display-shortcuts-help">

            Display keyboard shortcuts

          </button>

          <button class="line footer-button night-mode-toggle">

            Toggle night mode

          </button>

          <button class="line footer-button display-quick-switch">

            Go to a HexDocs package

          </button>

          <button class="line footer-button tooltips-toggle">

            <span class="tooltips-option-disable">Disable tooltips</span>

            <span class="tooltips-option-enable">Enable tooltips</span>

          </button>

        </p>

      </footer>

    </div>

  </div>

</section>

</div>

  </body>

</html>