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

242 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.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::base64_enc 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>
<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.9.7 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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__enc.html">base64_enc</a></li> </ul>
</div>
</div><!-- top -->
<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__enc-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::base64_enc Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Base64 encoding session.
<a href="classstdex_1_1base64__enc.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="base64_8hpp_source.html">stdex/base64.hpp</a>&gt;</code></p>
<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:abc6c72530634c3fea8168710ab5b1a28"><td class="memItemLeft" align="right" valign="top"><a id="abc6c72530634c3fea8168710ab5b1a28" name="abc6c72530634c3fea8168710ab5b1a28"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>base64_enc</b> () noexcept</td></tr>
<tr class="memdesc:abc6c72530634c3fea8168710ab5b1a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs blank encoding session. <br /></td></tr>
<tr class="separator:abc6c72530634c3fea8168710ab5b1a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ee96b5ec63fecc20c44afe1f1df6f04"><td class="memTemplParams" colspan="2">template&lt;class _Elem , class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:a0ee96b5ec63fecc20c44afe1f1df6f04"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classstdex_1_1base64__enc.html#a0ee96b5ec63fecc20c44afe1f1df6f04">encode</a> (std::basic_string&lt; _Elem, _Traits, _Ax &gt; &amp;out, const void *data, size_t size, bool is_last=true)</td></tr>
<tr class="memdesc:a0ee96b5ec63fecc20c44afe1f1df6f04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes one block of information, and <em>appends</em> it to the output. <br /></td></tr>
<tr class="separator:a0ee96b5ec63fecc20c44afe1f1df6f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb6a85176589d9ce1f65ce6355592fe7"><td class="memItemLeft" align="right" valign="top"><a id="afb6a85176589d9ce1f65ce6355592fe7" name="afb6a85176589d9ce1f65ce6355592fe7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> () noexcept</td></tr>
<tr class="memdesc:afb6a85176589d9ce1f65ce6355592fe7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets encoding session. <br /></td></tr>
<tr class="separator:afb6a85176589d9ce1f65ce6355592fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbae8f49a0948ea7bb23d0faa8f67f21"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1base64__enc.html#afbae8f49a0948ea7bb23d0faa8f67f21">enc_size</a> (size_t size) const noexcept</td></tr>
<tr class="memdesc:afbae8f49a0948ea7bb23d0faa8f67f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns maximum encoded size. <br /></td></tr>
<tr class="separator:afbae8f49a0948ea7bb23d0faa8f67f21"><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:a506985ccd54fd95dbc021457881d77c2"><td class="memTemplParams" colspan="2"><a id="a506985ccd54fd95dbc021457881d77c2" name="a506985ccd54fd95dbc021457881d77c2"></a>
template&lt;class _Elem , class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:a506985ccd54fd95dbc021457881d77c2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>encode</b> (std::basic_string&lt; _Elem, _Traits, _Ax &gt; &amp;out)</td></tr>
<tr class="memdesc:a506985ccd54fd95dbc021457881d77c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes one complete internal buffer of data. <br /></td></tr>
<tr class="separator:a506985ccd54fd95dbc021457881d77c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a709172f7120284fcea1d7856d8ff550d"><td class="memTemplParams" colspan="2"><a id="a709172f7120284fcea1d7856d8ff550d" name="a709172f7120284fcea1d7856d8ff550d"></a>
template&lt;class _Elem , class _Traits , class _Ax &gt; </td></tr>
<tr class="memitem:a709172f7120284fcea1d7856d8ff550d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>encode</b> (std::basic_string&lt; _Elem, _Traits, _Ax &gt; &amp;out, size_t size)</td></tr>
<tr class="memdesc:a709172f7120284fcea1d7856d8ff550d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes partial internal buffer of data. <br /></td></tr>
<tr class="separator:a709172f7120284fcea1d7856d8ff550d"><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:aea9a31d698c85699d492b095ea569d73"><td class="memItemLeft" align="right" valign="top"><a id="aea9a31d698c85699d492b095ea569d73" name="aea9a31d698c85699d492b095ea569d73"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>buf</b> [3]</td></tr>
<tr class="memdesc:aea9a31d698c85699d492b095ea569d73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal buffer. <br /></td></tr>
<tr class="separator:aea9a31d698c85699d492b095ea569d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58e4759143972065f71ed68f6dbc90d8"><td class="memItemLeft" align="right" valign="top"><a id="a58e4759143972065f71ed68f6dbc90d8" name="a58e4759143972065f71ed68f6dbc90d8"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>num</b></td></tr>
<tr class="memdesc:a58e4759143972065f71ed68f6dbc90d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes used in <code>buf</code> <br /></td></tr>
<tr class="separator:a58e4759143972065f71ed68f6dbc90d8"><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 encoding session. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afbae8f49a0948ea7bb23d0faa8f67f21" name="afbae8f49a0948ea7bb23d0faa8f67f21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbae8f49a0948ea7bb23d0faa8f67f21">&#9670;&#160;</a></span>enc_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_enc::enc_size </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em></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 encoded 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 encode</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Maximum number of bytes for the encoded data of <code>size</code> length </dd></dl>
</div>
</div>
<a id="a0ee96b5ec63fecc20c44afe1f1df6f04" name="a0ee96b5ec63fecc20c44afe1f1df6f04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ee96b5ec63fecc20c44afe1f1df6f04">&#9670;&#160;</a></span>encode()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Elem , class _Traits , class _Ax &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void stdex::base64_enc::encode </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; _Elem, _Traits, _Ax &gt; &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_last</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Encodes 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">[out]</td><td class="paramname">out</td><td>Output </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data to encode </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Length of <code>data</code> in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_last</td><td>Is this the last block of data? </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 Tue Aug 22 2023 15:16:47 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.9.7
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink