base64.h File Reference

Routines for base64 encoding and decoding taken and modified from the Base64 project at base64.sourceforge.net. More...

#include "regina-core.h"
#include <cstddef>

Namespaces
namespace	regina
	Contains the entire Regina calculation engine.

Functions
size_t	regina::base64Length (size_t bytes)
	Returns the number of base64 characters required to encode the given number of bytes. More...
bool	regina::isBase64 (char ch)
	Determines whether the given character is a base64 printable character as used by the base64 routines in Regina. More...
void	regina::base64Encode (const char *in, size_t inlen, char *out, size_t outlen)
	Encodes the given sequence of raw bytes in base64, and writes the results into a preallocated output buffer. More...
size_t	regina::base64Encode (const char *in, size_t inlen, char **out)
	Encodes the given sequence of raw bytes in base64, and passes back a newly allocated array containing the results. More...
bool	regina::base64Decode (const char *in, size_t inlen, char *out, size_t *outlen)
	Decodes the given sequence of base64 characters, and writes the resulting raw bytes into a preallocated output buffer. More...
bool	regina::base64Decode (const char *in, size_t inlen, char **out, size_t *outlen)
	Decodes the given sequence of base64 characters, and passes back a newly allocated array containing the results. More...

Variables
constexpr char	regina::base64Table []
	The table of all base64 printable characters, as used by the base64 routines in Regina. More...
constexpr char	regina::base64Spare [] = "_-."
	A table of printable characters that are not amongst the base64 printable characters used by Regina. More...

Detailed Description

Routines for base64 encoding and decoding taken and modified from the Base64 project at base64.sourceforge.net.

The Base64 copyright notice is as follows:

Copyright (c) 2001 Bob Trower, Trantor Standard Systems Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.