b64_8h_source.html 13 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>José: /home/nmccallu/Projects/jose/jose/b64.h Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">José
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. <!-- window showing the filter options -->
  46. <div id="MSearchSelectWindow"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. onkeydown="return searchBox.OnSearchSelectKey(event)">
  50. </div>
  51. <!-- iframe showing the search results (closed by default) -->
  52. <div id="MSearchResultsWindow">
  53. <iframe src="javascript:void(0)" frameborder="0"
  54. name="MSearchResults" id="MSearchResults">
  55. </iframe>
  56. </div>
  57. <div id="nav-path" class="navpath">
  58. <ul>
  59. <li class="navelem"><a class="el" href="dir_f2bd36b8a3f3d476e48bdb5015c9fdfb.html">jose</a></li> </ul>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="headertitle">
  64. <div class="title">b64.h</div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* vim: set tabstop=8 shiftwidth=4 softtabstop=4 expandtab smarttab colorcolumn=80: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2016 Red Hat, Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;io.h&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;jansson.h&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#define JOSE_B64_MAP &quot;ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_&quot;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keywordtype">size_t</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="group__jose__b64.html#gaf86ee58b51e590f9dac0bb29ee5800ff">jose_b64_dec</a>(<span class="keyword">const</span> json_t *i, <span class="keywordtype">void</span> *o, <span class="keywordtype">size_t</span> ol);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<a class="code" href="group__jose__b64.html#ga8e16b78e3713aacb5bdcdc16730a3a98">jose_b64_dec_io</a>(<a class="code" href="structjose__io__t.html">jose_io_t</a> *next);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="keywordtype">size_t</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<a class="code" href="group__jose__b64.html#ga75953a3138781b2ad2809395587b1f44">jose_b64_dec_buf</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *i, <span class="keywordtype">size_t</span> il, <span class="keywordtype">void</span> *o, <span class="keywordtype">size_t</span> ol);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;json_t *</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<a class="code" href="group__jose__b64.html#ga1fa229e6903d5cc41403a2b137fcff18">jose_b64_dec_load</a>(<span class="keyword">const</span> json_t *i);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;json_t *</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<a class="code" href="group__jose__b64.html#gab8e19831335f6990bfea85d21b946e72">jose_b64_enc</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *i, <span class="keywordtype">size_t</span> il);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<a class="code" href="group__jose__b64.html#gad72c180de43c9da3456bdb0d166092ff">jose_b64_enc_io</a>(<a class="code" href="structjose__io__t.html">jose_io_t</a> *next);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="keywordtype">size_t</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<a class="code" href="group__jose__b64.html#ga2a35d8159cc76af42482df6db36543b0">jose_b64_enc_buf</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *i, <span class="keywordtype">size_t</span> il, <span class="keywordtype">void</span> *o, <span class="keywordtype">size_t</span> ol);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;json_t *</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<a class="code" href="group__jose__b64.html#ga244aaa61d745e3eb3dfa5fb4a204fa68">jose_b64_enc_dump</a>(<span class="keyword">const</span> json_t *i);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div><div class="ttc" id="group__jose__b64_html_ga2a35d8159cc76af42482df6db36543b0"><div class="ttname"><a href="group__jose__b64.html#ga2a35d8159cc76af42482df6db36543b0">jose_b64_enc_buf</a></div><div class="ttdeci">size_t jose_b64_enc_buf(const void *i, size_t il, void *o, size_t ol)</div><div class="ttdoc">Encodes data to a URL-safe Base64 buffer. </div></div>
  68. <div class="ttc" id="group__jose__b64_html_gab8e19831335f6990bfea85d21b946e72"><div class="ttname"><a href="group__jose__b64.html#gab8e19831335f6990bfea85d21b946e72">jose_b64_enc</a></div><div class="ttdeci">json_t * jose_b64_enc(const void *i, size_t il)</div><div class="ttdoc">Encodes data to a URL-safe Base64 JSON string. </div></div>
  69. <div class="ttc" id="structjose__io__t_html"><div class="ttname"><a href="structjose__io__t.html">jose_io_t</a></div><div class="ttdoc">The interface for chained IO. </div><div class="ttdef"><b>Definition:</b> io.h:61</div></div>
  70. <div class="ttc" id="group__jose__b64_html_gad72c180de43c9da3456bdb0d166092ff"><div class="ttname"><a href="group__jose__b64.html#gad72c180de43c9da3456bdb0d166092ff">jose_b64_enc_io</a></div><div class="ttdeci">jose_io_t * jose_b64_enc_io(jose_io_t *next)</div><div class="ttdoc">Creates a new IO object which performs URL-safe Base64 encoding. </div></div>
  71. <div class="ttc" id="group__jose__b64_html_ga1fa229e6903d5cc41403a2b137fcff18"><div class="ttname"><a href="group__jose__b64.html#ga1fa229e6903d5cc41403a2b137fcff18">jose_b64_dec_load</a></div><div class="ttdeci">json_t * jose_b64_dec_load(const json_t *i)</div><div class="ttdoc">Decodes a JSON string from a URL-safe Base64 JSON string. </div></div>
  72. <div class="ttc" id="group__jose__b64_html_ga8e16b78e3713aacb5bdcdc16730a3a98"><div class="ttname"><a href="group__jose__b64.html#ga8e16b78e3713aacb5bdcdc16730a3a98">jose_b64_dec_io</a></div><div class="ttdeci">jose_io_t * jose_b64_dec_io(jose_io_t *next)</div><div class="ttdoc">Creates a new IO object which performs URL-safe Base64 decoding. </div></div>
  73. <div class="ttc" id="group__jose__b64_html_ga244aaa61d745e3eb3dfa5fb4a204fa68"><div class="ttname"><a href="group__jose__b64.html#ga244aaa61d745e3eb3dfa5fb4a204fa68">jose_b64_enc_dump</a></div><div class="ttdeci">json_t * jose_b64_enc_dump(const json_t *i)</div><div class="ttdoc">Encodes the input JSON as a URL-safe Base64 JSON string. </div></div>
  74. <div class="ttc" id="group__jose__b64_html_ga75953a3138781b2ad2809395587b1f44"><div class="ttname"><a href="group__jose__b64.html#ga75953a3138781b2ad2809395587b1f44">jose_b64_dec_buf</a></div><div class="ttdeci">size_t jose_b64_dec_buf(const void *i, size_t il, void *o, size_t ol)</div><div class="ttdoc">Decodes a URL-safe Base64 buffer to an output buffer. </div></div>
  75. <div class="ttc" id="group__jose__b64_html_gaf86ee58b51e590f9dac0bb29ee5800ff"><div class="ttname"><a href="group__jose__b64.html#gaf86ee58b51e590f9dac0bb29ee5800ff">jose_b64_dec</a></div><div class="ttdeci">size_t jose_b64_dec(const json_t *i, void *o, size_t ol)</div><div class="ttdoc">Decodes a URL-safe Base64 JSON string to a buffer. </div></div>
  76. </div><!-- fragment --></div><!-- contents -->
  77. <!-- start footer part -->
  78. <hr class="footer"/><address class="footer"><small>
  79. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  80. <img class="footer" src="doxygen.png" alt="doxygen"/>
  81. </a> 1.8.13
  82. </small></address>
  83. </body>
  84. </html>