blob: 4a02496024cc3ac28b7f51fc5e2a0273c8d4649a [file]
<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::Base64 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">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1Base64.html">Base64</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1Base64-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::Base64 Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Utilities for base64 and base64url encoding and decoding.
<a href="classiceberg_1_1Base64.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="base64_8h_source.html">base64.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a011efb328aa6be553c786c086d5d9a66" id="r_a011efb328aa6be553c786c086d5d9a66"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Base64.html#a011efb328aa6be553c786c086d5d9a66">Encode</a> (std::string_view data)</td></tr>
<tr class="memdesc:a011efb328aa6be553c786c086d5d9a66"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classiceberg_1_1Base64.html" title="Utilities for base64 and base64url encoding and decoding.">Base64</a> encode a string (standard alphabet: +/). <br /></td></tr>
<tr class="separator:a011efb328aa6be553c786c086d5d9a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9737593d0adc427e8f933ad650c25e3c" id="r_a9737593d0adc427e8f933ad650c25e3c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Base64.html#a9737593d0adc427e8f933ad650c25e3c">Decode</a> (std::string_view encoded)</td></tr>
<tr class="memdesc:a9737593d0adc427e8f933ad650c25e3c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classiceberg_1_1Base64.html" title="Utilities for base64 and base64url encoding and decoding.">Base64</a> decode a string (standard alphabet: +/). <br /></td></tr>
<tr class="separator:a9737593d0adc427e8f933ad650c25e3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05001378fe15eebeab3b9ce88d593e13" id="r_a05001378fe15eebeab3b9ce88d593e13"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Base64.html#a05001378fe15eebeab3b9ce88d593e13">UrlEncode</a> (std::string_view data)</td></tr>
<tr class="memdesc:a05001378fe15eebeab3b9ce88d593e13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base64url encode a string (URL-safe alphabet: -_). <br /></td></tr>
<tr class="separator:a05001378fe15eebeab3b9ce88d593e13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41463139e44cccfb068986b5abe5d0f1" id="r_a41463139e44cccfb068986b5abe5d0f1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Base64.html#a41463139e44cccfb068986b5abe5d0f1">UrlDecode</a> (std::string_view encoded)</td></tr>
<tr class="memdesc:a41463139e44cccfb068986b5abe5d0f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base64url decode a string (URL-safe alphabet: -_). <br /></td></tr>
<tr class="separator:a41463139e44cccfb068986b5abe5d0f1"><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>Utilities for base64 and base64url encoding and decoding. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9737593d0adc427e8f933ad650c25e3c" name="a9737593d0adc427e8f933ad650c25e3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9737593d0adc427e8f933ad650c25e3c">&#9670;&#160;</a></span>Decode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt; iceberg::Base64::Decode </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>encoded</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classiceberg_1_1Base64.html" title="Utilities for base64 and base64url encoding and decoding.">Base64</a> decode a string (standard alphabet: +/). </p>
<p>Handles optional padding ('='). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoded</td><td>The base64-encoded string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Decoded string, or an error if the input contains invalid characters. </dd></dl>
</div>
</div>
<a id="a011efb328aa6be553c786c086d5d9a66" name="a011efb328aa6be553c786c086d5d9a66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a011efb328aa6be553c786c086d5d9a66">&#9670;&#160;</a></span>Encode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string iceberg::Base64::Encode </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classiceberg_1_1Base64.html" title="Utilities for base64 and base64url encoding and decoding.">Base64</a> encode a string (standard alphabet: +/). </p>
<p>The output is padded with '=' to a multiple of 4 characters.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The string to encode. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The base64-encoded string. </dd></dl>
</div>
</div>
<a id="a41463139e44cccfb068986b5abe5d0f1" name="a41463139e44cccfb068986b5abe5d0f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41463139e44cccfb068986b5abe5d0f1">&#9670;&#160;</a></span>UrlDecode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt; iceberg::Base64::UrlDecode </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>encoded</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Base64url decode a string (URL-safe alphabet: -_). </p>
<p>Handles optional padding ('='). This variant uses '-' and '_' instead of '+' and '/' per RFC 4648 §5. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoded</td><td>The base64url-encoded string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Decoded string, or an error if the input contains invalid characters. </dd></dl>
</div>
</div>
<a id="a05001378fe15eebeab3b9ce88d593e13" name="a05001378fe15eebeab3b9ce88d593e13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05001378fe15eebeab3b9ce88d593e13">&#9670;&#160;</a></span>UrlEncode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string iceberg::Base64::UrlEncode </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Base64url encode a string (URL-safe alphabet: -_). </p>
<p>This variant uses '-' and '_' instead of '+' and '/' per RFC 4648 §5 and emits no '=' padding, matching the encoding commonly used by JWTs.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The string to encode. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The base64url-encoded string (without padding). </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/util/<a class="el" href="base64_8h_source.html">base64.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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.8
</small></address>
</body>
</html>