-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from christophhagen/documentation
Add HTML Documentation
- Loading branch information
Showing
86 changed files
with
26,109 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,326 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>Enumerations Reference</title> | ||
| <link rel="stylesheet" type="text/css" href="css/jazzy.css" /> | ||
| <link rel="stylesheet" type="text/css" href="css/highlight.css" /> | ||
| <meta charset='utf-8'> | ||
| <script src="js/jquery.min.js" defer></script> | ||
| <script src="js/jazzy.js" defer></script> | ||
|
|
||
| <script src="js/lunr.min.js" defer></script> | ||
| <script src="js/typeahead.jquery.js" defer></script> | ||
| <script src="js/jazzy.search.js" defer></script> | ||
| </head> | ||
| <body> | ||
| <a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a> | ||
| <a title="Enumerations Reference"></a> | ||
| <header> | ||
| <div class="content-wrapper"> | ||
| <p><a href="index.html"> Docs</a> (100% documented)</p> | ||
| <p class="header-right"><a href="https://github.com/christophhagen/BinaryCodable"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p> | ||
| <div class="header-right"> | ||
| <form role="search" action="search.json"> | ||
| <input type="text" placeholder="Search documentation" data-typeahead> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="content-wrapper"> | ||
| <p id="breadcrumbs"> | ||
| <a href="index.html"> Reference</a> | ||
| <img id="carat" src="img/carat.png" alt=""/> | ||
| Enumerations Reference | ||
| </p> | ||
| </div> | ||
| <div class="content-wrapper"> | ||
| <nav class="sidebar"> | ||
| <ul class="nav-groups"> | ||
| <li class="nav-group-name"> | ||
| <a href="Guides.html">Guides</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="binaryformat.html">BinaryFormat</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="protobufsupport.html">ProtobufSupport</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Classes.html">Classes</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Classes/BinaryDecoder.html">BinaryDecoder</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Classes/BinaryEncoder.html">BinaryEncoder</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Classes/ProtobufDecoder.html">ProtobufDecoder</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Classes/ProtobufEncoder.html">ProtobufEncoder</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Enums.html">Enumerations</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Enums/BinaryDecodingError.html">BinaryDecodingError</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Enums/BinaryEncodingError.html">BinaryEncodingError</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Enums/DataType.html">DataType</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Enums/ProtobufDecodingError.html">ProtobufDecodingError</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Enums/ProtobufEncodingError.html">ProtobufEncodingError</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Extensions.html">Extensions</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:Sb">Bool</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:10Foundation4DataV">Data</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:13BinaryCodable11DecodingKeyO">DecodingKey</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:Sf">Float</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions/Int.html">Int</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions/Int32.html">Int32</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions/Int64.html">Int64</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:13BinaryCodable13IntKeyWrapperV">IntKeyWrapper</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:13BinaryCodable21MixedCodingKeyWrapperV">MixedCodingKeyWrapper</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:13BinaryCodable15ProtoKeyWrapperV">ProtoKeyWrapper</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions.html#/s:SS">String</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions/UInt.html">UInt</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions/UInt32.html">UInt32</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Extensions/UInt64.html">UInt64</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Protocols.html">Protocols</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Protocols/FixedSizeCompatible.html">FixedSizeCompatible</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Protocols.html#/s:13BinaryCodable13ProtobufOneOfP">ProtobufOneOf</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Protocols/SignedValueCompatible.html">SignedValueCompatible</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Structs.html">Structures</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Structs/FixedSize.html">FixedSize</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Structs/SignedValue.html">SignedValue</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <article class="main-content"> | ||
| <section> | ||
| <section class="section"> | ||
| <h1>Enumerations</h1> | ||
| <p>The following enumerations are available globally.</p> | ||
|
|
||
| </section> | ||
| <section class="section task-group-section"> | ||
| <div class="task-group"> | ||
| <ul> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:13BinaryCodable0A13DecodingErrorO"></a> | ||
| <a name="//apple_ref/swift/Enum/BinaryDecodingError" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:13BinaryCodable0A13DecodingErrorO">BinaryDecodingError</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>An error produced while decoding binary data.</p> | ||
|
|
||
| <a href="Enums/BinaryDecodingError.html" class="slightly-smaller">See more</a> | ||
| </div> | ||
| <div class="declaration"> | ||
| <h4>Declaration</h4> | ||
| <div class="language"> | ||
| <p class="aside-title">Swift</p> | ||
| <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">BinaryDecodingError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:13BinaryCodable0A13EncodingErrorO"></a> | ||
| <a name="//apple_ref/swift/Enum/BinaryEncodingError" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:13BinaryCodable0A13EncodingErrorO">BinaryEncodingError</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>An error thrown when encoding a value using <code><a href="Classes/BinaryEncoder.html">BinaryEncoder</a></code>.</p> | ||
|
|
||
| <a href="Enums/BinaryEncodingError.html" class="slightly-smaller">See more</a> | ||
| </div> | ||
| <div class="declaration"> | ||
| <h4>Declaration</h4> | ||
| <div class="language"> | ||
| <p class="aside-title">Swift</p> | ||
| <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">BinaryEncodingError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:13BinaryCodable8DataTypeO"></a> | ||
| <a name="//apple_ref/swift/Enum/DataType" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:13BinaryCodable8DataTypeO">DataType</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>The data type specifying how a value is encoded on the wire.</p> | ||
|
|
||
| <p>The data type is mixed into the key for each value to indicate how many bytes the value occupies in the following bytes.</p> | ||
|
|
||
| <p>The data type is equivalent to the <a href="https://developers.google.com/protocol-buffers/docs/encoding#structure">Protocol Buffer Wire Type</a>, but extended to support more data types.</p> | ||
|
|
||
| <a href="Enums/DataType.html" class="slightly-smaller">See more</a> | ||
| </div> | ||
| <div class="declaration"> | ||
| <h4>Declaration</h4> | ||
| <div class="language"> | ||
| <p class="aside-title">Swift</p> | ||
| <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:13BinaryCodable21ProtobufDecodingErrorO"></a> | ||
| <a name="//apple_ref/swift/Enum/ProtobufDecodingError" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:13BinaryCodable21ProtobufDecodingErrorO">ProtobufDecodingError</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>An error produced while decoding binary data.</p> | ||
|
|
||
| <a href="Enums/ProtobufDecodingError.html" class="slightly-smaller">See more</a> | ||
| </div> | ||
| <div class="declaration"> | ||
| <h4>Declaration</h4> | ||
| <div class="language"> | ||
| <p class="aside-title">Swift</p> | ||
| <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ProtobufDecodingError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:13BinaryCodable21ProtobufEncodingErrorO"></a> | ||
| <a name="//apple_ref/swift/Enum/ProtobufEncodingError" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:13BinaryCodable21ProtobufEncodingErrorO">ProtobufEncodingError</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>An error thrown when encoding a value using <code><a href="Classes/ProtobufEncoder.html">ProtobufEncoder</a></code>.</p> | ||
|
|
||
| <a href="Enums/ProtobufEncodingError.html" class="slightly-smaller">See more</a> | ||
| </div> | ||
| <div class="declaration"> | ||
| <h4>Declaration</h4> | ||
| <div class="language"> | ||
| <p class="aside-title">Swift</p> | ||
| <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ProtobufEncodingError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <section id="footer"> | ||
| <p>© 2022 <a class="link" href="https://christophhagen.de" target="_blank" rel="external noopener">Christoph Hagen</a>. All rights reserved. (Last updated: 2022-07-19)</p> | ||
| <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p> | ||
| </section> | ||
| </article> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.