hexdump.h File Reference

Detailed Description

Declaration of the hexdump() functions and associated types.

Date

Created on September 25, 2018

Copyright

Copyright 2018-2024 Deutsches Elektronen-Synchrotron (DESY), Hamburg

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.

#include <iomanip>
#include <sstream>
#include <string_view>
#include <type_traits>
#include <utility>
#include "gul17/internal.h"

Include dependency graph for hexdump.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	gul17::HexdumpParameterForward< IteratorT, ContainerT >
	Helper object used to enable a convenient syntax to dump things to a stream. More...

Namespaces
namespace	gul17
	Namespace gul17 contains all functions and classes of the General Utility Library.

Functions
template<typename IteratorT , typename = std::enable_if_t<detail::IsHexDumpIterator<IteratorT>::value>>
std::string	gul17::hexdump (IteratorT begin, IteratorT end, std::string_view prompt="")
	Generate a hexdump of a data range and return it as a string.
template<typename ContainerT , typename = std::enable_if_t<detail::IsHexDumpContainer<ContainerT>::value>>
std::string	gul17::hexdump (const ContainerT &cont, std::string_view prompt="")
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename IteratorT , typename = std::enable_if_t<detail::IsHexDumpIterator<IteratorT>::value>>
HexdumpParameterForward< const IteratorT >	gul17::hexdump_stream (const IteratorT &begin, const IteratorT &end, std::string prompt="")
	Generate a hexdump of a data range that can be efficiently written to a stream using operator<<.
template<typename ContainerT , typename = std::enable_if_t<detail::IsHexDumpContainer<ContainerT>::value>>
HexdumpParameterForward< const decltype(std::declval< ContainerT >().cbegin())>	gul17::hexdump_stream (const ContainerT &cont, std::string prompt="")
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename ContainerT , typename = std::enable_if_t<detail::IsHexDumpContainer<ContainerT>::value, decltype(HexdumpParameterForward<decltype(std::declval<ContainerT>().cbegin()), ContainerT> {}, 0)>>
HexdumpParameterForward< decltype(std::declval< ContainerT >().cbegin()), ContainerT >	gul17::hexdump_stream (ContainerT &&cont, std::string prompt="")
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.