Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1base64__dec.html

252 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::base64_dec Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1base64__dec.html">base64_dec</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1base64__dec-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::base64_dec Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Base64 decoding session.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="base64_8hpp_source.html">stdex/base64.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stdex::base64_dec:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1base64__dec.png" usemap="#stdex::base64_5Fdec_map" alt=""/>
<map id="stdex::base64_5Fdec_map" name="stdex::base64_5Fdec_map">
<area href="classstdex_1_1base64__reader.html" title="Converts from Base64 when reading from a stream." alt="stdex::base64_reader" shape="rect" coords="0,56,133,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a17d956a883e99d8d884d2cb2edade8c5" id="r_a17d956a883e99d8d884d2cb2edade8c5"><td class="memItemLeft" align="right" valign="top"><a id="a17d956a883e99d8d884d2cb2edade8c5" name="a17d956a883e99d8d884d2cb2edade8c5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>base64_dec</b> () noexcept</td></tr>
<tr class="memdesc:a17d956a883e99d8d884d2cb2edade8c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs blank decoding session. <br /></td></tr>
<tr class="separator:a17d956a883e99d8d884d2cb2edade8c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94b0860b19c61f53208b79fcfd1ac32f" id="r_a94b0860b19c61f53208b79fcfd1ac32f"><td class="memTemplParams" colspan="2">template&lt;class T_to , class AX , class T_from &gt; </td></tr>
<tr class="memitem:a94b0860b19c61f53208b79fcfd1ac32f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a94b0860b19c61f53208b79fcfd1ac32f">decode</a> (std::vector&lt; T_to, AX &gt; &amp;out, bool &amp;is_last, const T_from *data, size_t size)</td></tr>
<tr class="memdesc:a94b0860b19c61f53208b79fcfd1ac32f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes one block of information, and <em>appends</em> it to the output. <br /></td></tr>
<tr class="separator:a94b0860b19c61f53208b79fcfd1ac32f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94738b63789489022e0c16063b732305" id="r_a94738b63789489022e0c16063b732305"><td class="memItemLeft" align="right" valign="top"><a id="a94738b63789489022e0c16063b732305" name="a94738b63789489022e0c16063b732305"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> () noexcept</td></tr>
<tr class="memdesc:a94738b63789489022e0c16063b732305"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets decoding session. <br /></td></tr>
<tr class="separator:a94738b63789489022e0c16063b732305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a203f2afa5839242c1230cb22e0a65b25" id="r_a203f2afa5839242c1230cb22e0a65b25"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a203f2afa5839242c1230cb22e0a65b25">dec_size</a> (size_t size) const noexcept</td></tr>
<tr class="memdesc:a203f2afa5839242c1230cb22e0a65b25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns maximum decoded size. <br /></td></tr>
<tr class="separator:a203f2afa5839242c1230cb22e0a65b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a07976a85f83981a29f9e1395d883a36d" id="r_a07976a85f83981a29f9e1395d883a36d"><td class="memTemplParams" colspan="2"><a id="a07976a85f83981a29f9e1395d883a36d" name="a07976a85f83981a29f9e1395d883a36d"></a>
template&lt;class T , class AX &gt; </td></tr>
<tr class="memitem:a07976a85f83981a29f9e1395d883a36d"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><b>decode</b> (std::vector&lt; T, AX &gt; &amp;out)</td></tr>
<tr class="memdesc:a07976a85f83981a29f9e1395d883a36d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes one complete internal buffer of data. <br /></td></tr>
<tr class="separator:a07976a85f83981a29f9e1395d883a36d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab618ef5b21f33c5ed577669091c4b103" id="r_ab618ef5b21f33c5ed577669091c4b103"><td class="memItemLeft" align="right" valign="top"><a id="ab618ef5b21f33c5ed577669091c4b103" name="ab618ef5b21f33c5ed577669091c4b103"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_buf</b> [4]</td></tr>
<tr class="memdesc:ab618ef5b21f33c5ed577669091c4b103"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal buffer. <br /></td></tr>
<tr class="separator:ab618ef5b21f33c5ed577669091c4b103"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04ab92bcef2c304bc7a5d8d2a03c7905" id="r_a04ab92bcef2c304bc7a5d8d2a03c7905"><td class="memItemLeft" align="right" valign="top"><a id="a04ab92bcef2c304bc7a5d8d2a03c7905" name="a04ab92bcef2c304bc7a5d8d2a03c7905"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num</b></td></tr>
<tr class="memdesc:a04ab92bcef2c304bc7a5d8d2a03c7905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes used in <code>m_buf</code> <br /></td></tr>
<tr class="separator:a04ab92bcef2c304bc7a5d8d2a03c7905"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base64 decoding session. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a203f2afa5839242c1230cb22e0a65b25" name="a203f2afa5839242c1230cb22e0a65b25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a203f2afa5839242c1230cb22e0a65b25">&#9670;&#160;</a></span>dec_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t stdex::base64_dec::dec_size </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns maximum decoded size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to decode</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Maximum number of bytes for the decoded data of <code>size</code> length </dd></dl>
</div>
</div>
<a id="a94b0860b19c61f53208b79fcfd1ac32f" name="a94b0860b19c61f53208b79fcfd1ac32f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94b0860b19c61f53208b79fcfd1ac32f">&#9670;&#160;</a></span>decode()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T_to , class AX , class T_from &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void stdex::base64_dec::decode </td>
<td>(</td>
<td class="paramtype">std::vector&lt; T_to, AX &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool &amp;</td> <td class="paramname"><span class="paramname"><em>is_last</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T_from *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Decodes one block of information, and <em>appends</em> it to the output. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">out</td><td>Output </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_last</td><td>Was this the last block of data? </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data to decode </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Length of <code>data</code> in bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="base64_8hpp_source.html">base64.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon May 27 2024 10:18:28 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink