jaulib v1.4.0-2-g788cf73
Jau Support Library (C++, Java, ..)
Loading...
Searching...
No Matches
Byte Utilities

Byte utility functions and types for endian- and bit conversions, inclusive alignment handling and general get & put functionality. More...

Collaboration diagram for Byte Utilities:

Namespaces

namespace  jau::impl
 

Classes

class  jau::AOctets< FixedSize >
 Persistent endian aware octet data, i.e. More...
 
class  jau::bitfield_t< StorageType, BitSize >
 Simple statically sized bitfield template for efficient bit storage access in O(1). More...
 
class  jau::bitheap
 Simple dynamically heap-sized bitheap for efficient bit storage access in O(1). More...
 
struct  jau::has_endian_big< Dummy_type >
 A big-endian type trait for convenience . More...
 
struct  jau::has_endian_little< Dummy_type >
 A little-endian type trait for convenience . More...
 
class  jau::POctets
 Persistent endian aware octet data, i.e. More...
 
class  jau::TOctets
 Transient endian aware octet data, i.e. More...
 
class  jau::TOctetSlice
 Transient endian aware octet data slice, i.e. More...
 
class  jau::TROOctets
 Transient read only and endian aware octet data, i.e. More...
 

Typedefs

template<size_t BitSize>
using jau::bitfield = bitfield_t<unsigned long, BitSize>
 Simple bitfield template for efficient bit storage access in O(1).
 

Enumerations

enum class  jau::endian_t : uint32_t {
  jau::endian_t::little = 0x41424344U , jau::endian_t::big = 0x44434241U , jau::endian_t::pdp = 0x43444142U , jau::endian_t::honeywell = 0x42414443U ,
  jau::endian_t::undefined = 0x00000000U , jau::endian_t::native = impl::get_host_order()
}
 Endian identifier, indicating endianess of all scalar types. More...
 
enum class  jau::lb_endian_t : uint32_t { jau::lb_endian_t::little = static_cast<uint32_t>( endian_t::little ) , jau::lb_endian_t::big = static_cast<uint32_t>( endian_t::big ) , jau::lb_endian_t::native = static_cast<uint32_t>( endian_t::native ) }
 Simplified reduced endian type only covering little- and big-endian. More...
 

Functions

constexpr int16_t jau::be_to_cpu (int16_t const n) noexcept
 
constexpr int32_t jau::be_to_cpu (int32_t const n) noexcept
 
constexpr int64_t jau::be_to_cpu (int64_t const &n) noexcept
 
constexpr uint128dp_t jau::be_to_cpu (uint128dp_t const &n) noexcept
 
constexpr uint16_t jau::be_to_cpu (uint16_t const n) noexcept
 
constexpr uint192dp_t jau::be_to_cpu (uint192dp_t const &n) noexcept
 
constexpr uint256dp_t jau::be_to_cpu (uint256dp_t const &n) noexcept
 
constexpr uint32_t jau::be_to_cpu (uint32_t const n) noexcept
 
constexpr uint64_t jau::be_to_cpu (uint64_t const &n) noexcept
 
template<jau::req::unsigned_integral T>
static constexpr T jau::bit_mask (size_t n) noexcept
 Returns the T bit mask of n-bits, i.e.
 
constexpr int16_t jau::bswap (int16_t const source) noexcept
 
constexpr int32_t jau::bswap (int32_t const source) noexcept
 
constexpr int64_t jau::bswap (int64_t const &source) noexcept
 
constexpr uint128dp_t jau::bswap (uint128dp_t const &source) noexcept
 
constexpr uint16_t jau::bswap (uint16_t const source) noexcept
 
constexpr uint192dp_t jau::bswap (uint192dp_t const &source) noexcept
 
constexpr uint256dp_t jau::bswap (uint256dp_t const &source) noexcept
 
constexpr uint32_t jau::bswap (uint32_t const source) noexcept
 
constexpr uint64_t jau::bswap (uint64_t const &source) noexcept
 
constexpr void jau::bswap (uint8_t *sink, uint8_t const *source, nsize_t len)
 
const uint8_t * jau::cast_char_ptr_to_uint8 (const char *s) noexcept
 
const char * jau::cast_uint8_ptr_to_char (const uint8_t *b) noexcept
 
char * jau::cast_uint8_ptr_to_char (uint8_t *b) noexcept
 
constexpr int16_t jau::cpu_to_be (int16_t const h) noexcept
 
constexpr int32_t jau::cpu_to_be (int32_t const h) noexcept
 
constexpr int64_t jau::cpu_to_be (int64_t const &h) noexcept
 
constexpr uint128dp_t jau::cpu_to_be (uint128dp_t const &h) noexcept
 
constexpr uint16_t jau::cpu_to_be (uint16_t const h) noexcept
 
constexpr uint192dp_t jau::cpu_to_be (uint192dp_t const &h) noexcept
 
constexpr uint256dp_t jau::cpu_to_be (uint256dp_t const &h) noexcept
 
constexpr uint32_t jau::cpu_to_be (uint32_t const h) noexcept
 
constexpr uint64_t jau::cpu_to_be (uint64_t const &h) noexcept
 
constexpr int16_t jau::cpu_to_le (int16_t const h) noexcept
 
constexpr int32_t jau::cpu_to_le (int32_t const h) noexcept
 
constexpr int64_t jau::cpu_to_le (int64_t const &h) noexcept
 
constexpr uint128dp_t jau::cpu_to_le (uint128dp_t const &h) noexcept
 
constexpr uint16_t jau::cpu_to_le (uint16_t const h) noexcept
 
constexpr uint192dp_t jau::cpu_to_le (uint192dp_t const &h) noexcept
 
constexpr uint256dp_t jau::cpu_to_le (uint256dp_t const &h) noexcept
 
constexpr uint32_t jau::cpu_to_le (uint32_t const h) noexcept
 
constexpr uint64_t jau::cpu_to_le (uint64_t const &h) noexcept
 
std::string jau::dfa_utf8_decode (const uint8_t *buffer, const size_t buffer_size)
 Returns all valid consecutive UTF-8 characters within buffer in the range up to buffer_size or until EOS.
 
uint32_t jau::dfa_utf8_decode (uint32_t &state, uint32_t &codep, const uint32_t byte_value)
 
constexpr int16_t jau::get_int16 (uint8_t const *buffer) noexcept
 Returns a int16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr int16_t jau::get_int16 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 Returns a int16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr int32_t jau::get_int32 (uint8_t const *buffer) noexcept
 See get_int16() for reference.
 
constexpr int32_t jau::get_int32 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_int16() for reference.
 
constexpr int64_t jau::get_int64 (uint8_t const *buffer) noexcept
 See get_int16() for reference.
 
constexpr int64_t jau::get_int64 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_int16() for reference.
 
constexpr int8_t jau::get_int8 (uint8_t const *buffer) noexcept
 
template<typename T>
constexpr T jau::get_packed_value (const packed_t< T > *source, const lb_endian_t byte_order) noexcept
 Return packed_t::store after converting it to from either lb_endian::little or lb_endian::big depending on given byte_order to lb_endian::native.
 
constexpr uint128dp_t jau::get_uint128 (uint8_t const *buffer) noexcept
 See get_uint16() for reference.
 
constexpr uint128dp_t jau::get_uint128 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_uint16() for reference.
 
constexpr uint16_t jau::get_uint16 (uint8_t const *buffer) noexcept
 Returns a uint16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr uint16_t jau::get_uint16 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 Returns a uint16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr uint192dp_t jau::get_uint192 (uint8_t const *buffer) noexcept
 See get_uint16() for reference.
 
constexpr uint192dp_t jau::get_uint192 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_uint16() for reference.
 
constexpr uint256dp_t jau::get_uint256 (uint8_t const *buffer) noexcept
 See get_uint16() for reference.
 
constexpr uint256dp_t jau::get_uint256 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_uint16() for reference.
 
constexpr uint32_t jau::get_uint32 (uint8_t const *buffer) noexcept
 See get_uint16() for reference.
 
constexpr uint32_t jau::get_uint32 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_uint16() for reference.
 
constexpr uint64_t jau::get_uint64 (uint8_t const *buffer) noexcept
 See get_uint16() for reference.
 
constexpr uint64_t jau::get_uint64 (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 See get_uint16() for reference.
 
constexpr uint8_t jau::get_uint8 (uint8_t const *buffer) noexcept
 
template<typename T>
constexpr std::enable_if_t< std::is_standard_layout_v< T >, T > jau::get_value (uint8_t const *buffer) noexcept
 Returns a T value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
template<typename T>
constexpr std::enable_if_t< std::is_standard_layout_v< T >, T > jau::get_value (uint8_t const *buffer, const lb_endian_t byte_order) noexcept
 Returns a T value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr bool jau::is_big_endian () noexcept
 Evaluates true if platform is running in big endian mode, i.e.
 
constexpr bool jau::is_defined_endian (const endian_t &v) noexcept
 Evaluates true if the given endian is defined, i.e.
 
constexpr bool jau::is_little_endian () noexcept
 Evaluates true if platform is running in little endian mode, i.e.
 
constexpr bool jau::is_little_endian (const endian_t byte_order) noexcept
 Returns true if given byte_order equals endian::little, otherwise false.
 
constexpr bool jau::is_little_endian (const lb_endian_t byte_order) noexcept
 Returns true if given byte_order equals lb_endian::little, otherwise false.
 
constexpr bool jau::is_little_or_big_endian () noexcept
 Evaluates true if platform is running in little or big endian mode, i.e.
 
constexpr int16_t jau::le_to_cpu (int16_t const l) noexcept
 
constexpr int32_t jau::le_to_cpu (int32_t const l) noexcept
 
constexpr int64_t jau::le_to_cpu (int64_t const &l) noexcept
 
constexpr uint128dp_t jau::le_to_cpu (uint128dp_t const &l) noexcept
 
constexpr uint16_t jau::le_to_cpu (uint16_t const l) noexcept
 
constexpr uint192dp_t jau::le_to_cpu (uint192dp_t const &l) noexcept
 
constexpr uint256dp_t jau::le_to_cpu (uint256dp_t const &l) noexcept
 
constexpr uint32_t jau::le_to_cpu (uint32_t const l) noexcept
 
constexpr uint64_t jau::le_to_cpu (uint64_t const &l) noexcept
 
template<jau::req::unsigned_integral StorageType, size_t BitSize>
requires requires (StorageType) { sizeof(StorageType) <= sizeof(size_t); }
std::ostream & jau::operator<< (std::ostream &out, const bitfield_t< StorageType, BitSize > &v)
 
std::ostream & jau::operator<< (std::ostream &out, const bitheap &v)
 
constexpr void jau::put_int16 (uint8_t *buffer, const int16_t v) noexcept
 Put the given int16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr void jau::put_int16 (uint8_t *buffer, const int16_t v, const lb_endian_t byte_order) noexcept
 Put the given uint16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr void jau::put_int32 (uint8_t *buffer, const int32_t v) noexcept
 See put_int16() for reference.
 
constexpr void jau::put_int32 (uint8_t *buffer, const int32_t v, const lb_endian_t byte_order) noexcept
 See put_int16() for reference.
 
constexpr void jau::put_int64 (uint8_t *buffer, const int64_t &v) noexcept
 See put_int16() for reference.
 
constexpr void jau::put_int64 (uint8_t *buffer, const int64_t &v, const lb_endian_t byte_order) noexcept
 See put_int16() for reference.
 
constexpr void jau::put_uint128 (uint8_t *buffer, const uint128dp_t &v) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint128 (uint8_t *buffer, const uint128dp_t &v, const lb_endian_t byte_order) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint16 (uint8_t *buffer, const uint16_t v) noexcept
 Put the given uint16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr void jau::put_uint16 (uint8_t *buffer, const uint16_t v, const lb_endian_t byte_order) noexcept
 Put the given uint16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
constexpr void jau::put_uint192 (uint8_t *buffer, const uint192dp_t &v) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint192 (uint8_t *buffer, const uint192dp_t &v, const lb_endian_t byte_order) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint256 (uint8_t *buffer, const uint256dp_t &v) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint256 (uint8_t *buffer, const uint256dp_t &v, const lb_endian_t byte_order) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint32 (uint8_t *buffer, const uint32_t v) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint32 (uint8_t *buffer, const uint32_t v, const lb_endian_t byte_order) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint64 (uint8_t *buffer, const uint64_t &v) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint64 (uint8_t *buffer, const uint64_t &v, const lb_endian_t byte_order) noexcept
 See put_uint16() for reference.
 
constexpr void jau::put_uint8 (uint8_t *buffer, const uint8_t v) noexcept
 
template<typename T>
constexpr std::enable_if_t< std::is_standard_layout_v< T >, void > jau::put_value (uint8_t *buffer, const T &v) noexcept
 Put the given T value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
template<typename T>
constexpr std::enable_if_t< std::is_standard_layout_v< T >, void > jau::put_value (uint8_t *buffer, const T &v, const lb_endian_t byte_order) noexcept
 Put the given T value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.
 
template<jau::req::unsigned_integral T>
constexpr T jau::rev_bits (jau::nsize_t n, T v)
 Reversed n bits of value v, this is an O(n) operation.
 
constexpr uint16_t jau::rev_bits (uint16_t v) noexcept
 Reverse bits of two bytes.
 
constexpr uint32_t jau::rev_bits (uint32_t v) noexcept
 Reverse bits of four bytes.
 
constexpr uint64_t jau::rev_bits (uint64_t v) noexcept
 Reverse bits of eight bytes.
 
constexpr uint8_t jau::rev_bits (uint8_t v) noexcept
 Reverse bits of one byte.
 
constexpr endian_t jau::to_endian (const lb_endian_t v) noexcept
 
constexpr lb_endian_t jau::to_lb_endian (const endian_t v) noexcept
 
std::string jau::to_string (const endian_t v) noexcept
 Return std::string representation of the given endian.
 
std::string jau::to_string (const lb_endian_t v) noexcept
 Return std::string representation of the given lb_endian.
 

Variables

template<typename Dummy_type>
constexpr bool jau::has_endian_big_v = has_endian_big<Dummy_type>::value
 Value access of big-endian type trait for convenience .
 
template<typename Dummy_type>
constexpr bool jau::has_endian_little_v = has_endian_little<Dummy_type>::value
 Value access of little-endian type trait for convenience .
 

Detailed Description

Byte utility functions and types for endian- and bit conversions, inclusive alignment handling and general get & put functionality.

This category is also supporting Integer types and arithmetic.

All endian API entries are of constexpr and hence evaluated at compile time.
Therefore, if-branches and expressions are also of constexpr and optimized 'away' at compile time.
This includes the cpu_to_<endian>(..) and <endian>_to_cpu(..) etc utility functions.

See endian enum class regarding endian constexpr compile time determination.

Aligned memory transfer from and to potentially unaligned memory is performed via put_uint16(), get_uint16() with all its explicit stdint types, as well as the generic template functions put_value() and get_value(). The implementation uses packed_t to resolve a potential memory alignment issue free of costs, see packed_t_alignment_cast.

Typedef Documentation

◆ bitfield

template<size_t BitSize>
using jau::bitfield = bitfield_t<unsigned long, BitSize>

Simple bitfield template for efficient bit storage access in O(1).

Implementations utilizes an in-memory std::array<unsigned long, (BitSize+31)/32> with unsigned long StorageType.

Alias for bitfield_t, using unsigned long for StorageType, i.e. at least 32bit or 64bit on LP64.

See also
jau::bitfield_t
jau::bitheap

Definition at line 499 of file bitfield.hpp.

Enumeration Type Documentation

◆ endian_t

enum class jau::endian_t : uint32_t
strong

Endian identifier, indicating endianess of all scalar types.

Inspired by C++20 std::endian

Corner case platforms currently not supported, i.e. unified endianess and mixed endianess.

All endian API entries are of constexpr and hence evaluated at compile time.
Therefore, if-branches and expressions are also of constexpr and optimized 'away' at compile time.
This includes the cpu_to_<endian>(..) and <endian>_to_cpu(..) etc utility functions.

On i386 platforms the host byte order is Least Significant Byte first (LSB) or Little-Endian, whereas the network byte order, as used on the Internet, is Most Significant Byte first (MSB) or Big-Endian. See #include <arpa/inet.h>

Bluetooth is LSB or Little-Endian!

See lb_endian

Enumerator
little 

Identifier for little endian.

big 

Identifier for big endian.

pdp 

Identifier for DEC PDP-11, aka ENDIAN_LITTLE_WORD.

honeywell 

Identifier for Honeywell 316, aka ENDIAN_BIG_WORD.

undefined 

Undetermined endian.

native 

Identifier for native platform type, one of the above.

Definition at line 237 of file byte_util.hpp.

◆ lb_endian_t

enum class jau::lb_endian_t : uint32_t
strong

Simplified reduced endian type only covering little- and big-endian.

See endian for details.

Enumerator
little 

Identifier for little endian, equivalent to endian::little.

big 

Identifier for big endian, equivalent to endian::big.

native 

Identifier for native platform type, one of the above.

Definition at line 261 of file byte_util.hpp.

Function Documentation

◆ operator<<() [1/2]

template<jau::req::unsigned_integral StorageType, size_t BitSize>
requires requires (StorageType) { sizeof(StorageType) <= sizeof(size_t); }
std::ostream & jau::operator<< ( std::ostream & out,
const bitfield_t< StorageType, BitSize > & v )
inline

Definition at line 483 of file bitfield.hpp.

◆ operator<<() [2/2]

std::ostream & jau::operator<< ( std::ostream & out,
const bitheap & v )
inline

Definition at line 489 of file bitheap.hpp.

◆ bswap() [1/10]

uint16_t jau::bswap ( uint16_t const source)
constexprnoexcept
Examples
test_basictypeconv.cpp.

Definition at line 88 of file byte_util.hpp.

◆ bswap() [2/10]

int16_t jau::bswap ( int16_t const source)
constexprnoexcept

Definition at line 97 of file byte_util.hpp.

◆ bswap() [3/10]

uint32_t jau::bswap ( uint32_t const source)
constexprnoexcept

Definition at line 106 of file byte_util.hpp.

◆ bswap() [4/10]

int32_t jau::bswap ( int32_t const source)
constexprnoexcept

Definition at line 117 of file byte_util.hpp.

◆ bswap() [5/10]

uint64_t jau::bswap ( uint64_t const & source)
constexprnoexcept

Definition at line 128 of file byte_util.hpp.

◆ bswap() [6/10]

int64_t jau::bswap ( int64_t const & source)
constexprnoexcept

Definition at line 143 of file byte_util.hpp.

◆ bswap() [7/10]

void jau::bswap ( uint8_t * sink,
uint8_t const * source,
nsize_t len )
constexpr

Definition at line 158 of file byte_util.hpp.

◆ bswap() [8/10]

uint128dp_t jau::bswap ( uint128dp_t const & source)
constexprnoexcept

Definition at line 165 of file byte_util.hpp.

◆ bswap() [9/10]

uint192dp_t jau::bswap ( uint192dp_t const & source)
constexprnoexcept

Definition at line 171 of file byte_util.hpp.

◆ bswap() [10/10]

uint256dp_t jau::bswap ( uint256dp_t const & source)
constexprnoexcept

Definition at line 177 of file byte_util.hpp.

◆ cast_uint8_ptr_to_char() [1/2]

char * jau::cast_uint8_ptr_to_char ( uint8_t * b)
inlinenoexcept

Definition at line 183 of file byte_util.hpp.

◆ cast_uint8_ptr_to_char() [2/2]

const char * jau::cast_uint8_ptr_to_char ( const uint8_t * b)
inlinenoexcept

Definition at line 186 of file byte_util.hpp.

◆ cast_char_ptr_to_uint8()

const uint8_t * jau::cast_char_ptr_to_uint8 ( const char * s)
inlinenoexcept

Definition at line 190 of file byte_util.hpp.

Here is the caller graph for this function:

◆ to_string() [1/2]

std::string jau::to_string ( const endian_t v)
noexcept

Return std::string representation of the given endian.

Parameters
vthe endian value
Returns
the std::string representation

Definition at line 884 of file basic_types.cpp.

◆ to_string() [2/2]

std::string jau::to_string ( const lb_endian_t v)
noexcept

Return std::string representation of the given lb_endian.

Parameters
vthe lb_endian value
Returns
the std::string representation

Definition at line 895 of file basic_types.cpp.

◆ to_lb_endian()

lb_endian_t jau::to_lb_endian ( const endian_t v)
constexprnoexcept

Definition at line 287 of file byte_util.hpp.

Here is the caller graph for this function:

◆ to_endian()

endian_t jau::to_endian ( const lb_endian_t v)
constexprnoexcept

Definition at line 296 of file byte_util.hpp.

◆ is_defined_endian()

bool jau::is_defined_endian ( const endian_t & v)
constexprnoexcept

Evaluates true if the given endian is defined, i.e.

little, big, pdp or honeywell.

Definition at line 310 of file byte_util.hpp.

Here is the caller graph for this function:

◆ is_little_endian() [1/3]

bool jau::is_little_endian ( const endian_t byte_order)
constexprnoexcept

Returns true if given byte_order equals endian::little, otherwise false.

Definition at line 328 of file byte_util.hpp.

Here is the caller graph for this function:

◆ is_little_endian() [2/3]

bool jau::is_little_endian ( const lb_endian_t byte_order)
constexprnoexcept

Returns true if given byte_order equals lb_endian::little, otherwise false.

Definition at line 335 of file byte_util.hpp.

◆ is_little_endian() [3/3]

bool jau::is_little_endian ( )
constexprnoexcept

Evaluates true if platform is running in little endian mode, i.e.

jau::endian::little == jau::endian::native.

Examples
test_basictypeconv.cpp.

Definition at line 343 of file byte_util.hpp.

◆ is_big_endian()

bool jau::is_big_endian ( )
constexprnoexcept

Evaluates true if platform is running in big endian mode, i.e.

jau::endian::big == jau::endian::native.

Definition at line 351 of file byte_util.hpp.

Here is the caller graph for this function:

◆ is_little_or_big_endian()

bool jau::is_little_or_big_endian ( )
constexprnoexcept

Evaluates true if platform is running in little or big endian mode, i.e.

jau::endian::little == jau::endian::native || jau::endian::big == jau::endian::native.

Definition at line 359 of file byte_util.hpp.

Here is the caller graph for this function:

◆ be_to_cpu() [1/9]

uint16_t jau::be_to_cpu ( uint16_t const n)
constexprnoexcept
Examples
test_basictypeconv.cpp.

Definition at line 413 of file byte_util.hpp.

Here is the caller graph for this function:

◆ cpu_to_be() [1/9]

uint16_t jau::cpu_to_be ( uint16_t const h)
constexprnoexcept

Definition at line 422 of file byte_util.hpp.

Here is the caller graph for this function:

◆ le_to_cpu() [1/9]

uint16_t jau::le_to_cpu ( uint16_t const l)
constexprnoexcept
Examples
test_basictypeconv.cpp.

Definition at line 431 of file byte_util.hpp.

Here is the caller graph for this function:

◆ cpu_to_le() [1/9]

uint16_t jau::cpu_to_le ( uint16_t const h)
constexprnoexcept

Definition at line 440 of file byte_util.hpp.

Here is the caller graph for this function:

◆ be_to_cpu() [2/9]

int16_t jau::be_to_cpu ( int16_t const n)
constexprnoexcept

Definition at line 450 of file byte_util.hpp.

◆ cpu_to_be() [2/9]

int16_t jau::cpu_to_be ( int16_t const h)
constexprnoexcept

Definition at line 459 of file byte_util.hpp.

◆ le_to_cpu() [2/9]

int16_t jau::le_to_cpu ( int16_t const l)
constexprnoexcept

Definition at line 468 of file byte_util.hpp.

◆ cpu_to_le() [2/9]

int16_t jau::cpu_to_le ( int16_t const h)
constexprnoexcept

Definition at line 477 of file byte_util.hpp.

◆ be_to_cpu() [3/9]

uint32_t jau::be_to_cpu ( uint32_t const n)
constexprnoexcept

Definition at line 487 of file byte_util.hpp.

◆ cpu_to_be() [3/9]

uint32_t jau::cpu_to_be ( uint32_t const h)
constexprnoexcept

Definition at line 496 of file byte_util.hpp.

◆ le_to_cpu() [3/9]

uint32_t jau::le_to_cpu ( uint32_t const l)
constexprnoexcept

Definition at line 505 of file byte_util.hpp.

◆ cpu_to_le() [3/9]

uint32_t jau::cpu_to_le ( uint32_t const h)
constexprnoexcept

Definition at line 514 of file byte_util.hpp.

◆ be_to_cpu() [4/9]

int32_t jau::be_to_cpu ( int32_t const n)
constexprnoexcept

Definition at line 524 of file byte_util.hpp.

◆ cpu_to_be() [4/9]

int32_t jau::cpu_to_be ( int32_t const h)
constexprnoexcept

Definition at line 533 of file byte_util.hpp.

◆ le_to_cpu() [4/9]

int32_t jau::le_to_cpu ( int32_t const l)
constexprnoexcept

Definition at line 542 of file byte_util.hpp.

◆ cpu_to_le() [4/9]

int32_t jau::cpu_to_le ( int32_t const h)
constexprnoexcept

Definition at line 551 of file byte_util.hpp.

◆ be_to_cpu() [5/9]

uint64_t jau::be_to_cpu ( uint64_t const & n)
constexprnoexcept

Definition at line 561 of file byte_util.hpp.

◆ cpu_to_be() [5/9]

uint64_t jau::cpu_to_be ( uint64_t const & h)
constexprnoexcept

Definition at line 570 of file byte_util.hpp.

◆ le_to_cpu() [5/9]

uint64_t jau::le_to_cpu ( uint64_t const & l)
constexprnoexcept

Definition at line 579 of file byte_util.hpp.

◆ cpu_to_le() [5/9]

uint64_t jau::cpu_to_le ( uint64_t const & h)
constexprnoexcept

Definition at line 588 of file byte_util.hpp.

◆ be_to_cpu() [6/9]

int64_t jau::be_to_cpu ( int64_t const & n)
constexprnoexcept

Definition at line 598 of file byte_util.hpp.

◆ cpu_to_be() [6/9]

int64_t jau::cpu_to_be ( int64_t const & h)
constexprnoexcept

Definition at line 607 of file byte_util.hpp.

◆ le_to_cpu() [6/9]

int64_t jau::le_to_cpu ( int64_t const & l)
constexprnoexcept

Definition at line 616 of file byte_util.hpp.

◆ cpu_to_le() [6/9]

int64_t jau::cpu_to_le ( int64_t const & h)
constexprnoexcept

Definition at line 625 of file byte_util.hpp.

◆ be_to_cpu() [7/9]

uint128dp_t jau::be_to_cpu ( uint128dp_t const & n)
constexprnoexcept

Definition at line 635 of file byte_util.hpp.

◆ cpu_to_be() [7/9]

uint128dp_t jau::cpu_to_be ( uint128dp_t const & h)
constexprnoexcept

Definition at line 644 of file byte_util.hpp.

◆ le_to_cpu() [7/9]

uint128dp_t jau::le_to_cpu ( uint128dp_t const & l)
constexprnoexcept

Definition at line 653 of file byte_util.hpp.

◆ cpu_to_le() [7/9]

uint128dp_t jau::cpu_to_le ( uint128dp_t const & h)
constexprnoexcept

Definition at line 662 of file byte_util.hpp.

◆ be_to_cpu() [8/9]

uint192dp_t jau::be_to_cpu ( uint192dp_t const & n)
constexprnoexcept

Definition at line 672 of file byte_util.hpp.

◆ cpu_to_be() [8/9]

uint192dp_t jau::cpu_to_be ( uint192dp_t const & h)
constexprnoexcept

Definition at line 681 of file byte_util.hpp.

◆ le_to_cpu() [8/9]

uint192dp_t jau::le_to_cpu ( uint192dp_t const & l)
constexprnoexcept

Definition at line 690 of file byte_util.hpp.

◆ cpu_to_le() [8/9]

uint192dp_t jau::cpu_to_le ( uint192dp_t const & h)
constexprnoexcept

Definition at line 699 of file byte_util.hpp.

◆ be_to_cpu() [9/9]

uint256dp_t jau::be_to_cpu ( uint256dp_t const & n)
constexprnoexcept

Definition at line 709 of file byte_util.hpp.

◆ cpu_to_be() [9/9]

uint256dp_t jau::cpu_to_be ( uint256dp_t const & h)
constexprnoexcept

Definition at line 718 of file byte_util.hpp.

◆ le_to_cpu() [9/9]

uint256dp_t jau::le_to_cpu ( uint256dp_t const & l)
constexprnoexcept

Definition at line 727 of file byte_util.hpp.

◆ cpu_to_le() [9/9]

uint256dp_t jau::cpu_to_le ( uint256dp_t const & h)
constexprnoexcept

Definition at line 736 of file byte_util.hpp.

◆ rev_bits() [1/5]

uint8_t jau::rev_bits ( uint8_t v)
constexprnoexcept

Reverse bits of one byte.

See also
https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
Examples
test_basictypeconv.cpp.

Definition at line 771 of file byte_util.hpp.

Here is the caller graph for this function:

◆ rev_bits() [2/5]

uint16_t jau::rev_bits ( uint16_t v)
constexprnoexcept

Reverse bits of two bytes.

See also
https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable

Definition at line 776 of file byte_util.hpp.

◆ rev_bits() [3/5]

uint32_t jau::rev_bits ( uint32_t v)
constexprnoexcept

Reverse bits of four bytes.

See also
https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable

Definition at line 784 of file byte_util.hpp.

◆ rev_bits() [4/5]

uint64_t jau::rev_bits ( uint64_t v)
constexprnoexcept

Reverse bits of eight bytes.

See also
https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable

Definition at line 794 of file byte_util.hpp.

◆ bit_mask()

static constexpr T jau::bit_mask ( size_t n)
staticconstexprnoexcept

Returns the T bit mask of n-bits, i.e.

n low order 1’s

Definition at line 807 of file byte_util.hpp.

Here is the caller graph for this function:

◆ rev_bits() [5/5]

T jau::rev_bits ( jau::nsize_t n,
T v )
constexpr

Reversed n bits of value v, this is an O(n) operation.

The reversed bits will stick in their n bits position, i.e. not shifted to the left of n bits as rev_bits(v) would.

See also
https://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable

Definition at line 823 of file byte_util.hpp.

◆ put_uint8()

void jau::put_uint8 ( uint8_t * buffer,
const uint8_t v )
constexprnoexcept

Definition at line 844 of file byte_util.hpp.

◆ get_uint8()

uint8_t jau::get_uint8 ( uint8_t const * buffer)
constexprnoexcept

Definition at line 848 of file byte_util.hpp.

◆ get_int8()

int8_t jau::get_int8 ( uint8_t const * buffer)
constexprnoexcept

Definition at line 852 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_packed_value()

template<typename T>
T jau::get_packed_value ( const packed_t< T > * source,
const lb_endian_t byte_order )
constexprnoexcept

Return packed_t::store after converting it to from either lb_endian::little or lb_endian::big depending on given byte_order to lb_endian::native.

Template Parameters
T
Parameters
source
byte_order

Definition at line 865 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint16() [1/2]

void jau::put_uint16 ( uint8_t * buffer,
const uint16_t v )
constexprnoexcept

Put the given uint16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

See also
packed_t_alignment_cast

Definition at line 875 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint16() [2/2]

void jau::put_uint16 ( uint8_t * buffer,
const uint16_t v,
const lb_endian_t byte_order )
constexprnoexcept

Put the given uint16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

The value is converted from lb_endian::native to either lb_endian::little or lb_endian::big depending on given byte_order before it is stored in memory.

See also
packed_t_alignment_cast

Definition at line 888 of file byte_util.hpp.

◆ get_uint16() [1/2]

uint16_t jau::get_uint16 ( uint8_t const * buffer)
constexprnoexcept

Returns a uint16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

See also
packed_t_alignment_cast

Definition at line 898 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_uint16() [2/2]

uint16_t jau::get_uint16 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

Returns a uint16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

The value is converted from either lb_endian::little or lb_endian::big depending on given byte_order to lb_endian::native before it is returned to the caller.

See also
packed_t_alignment_cast

Definition at line 911 of file byte_util.hpp.

◆ put_int16() [1/2]

void jau::put_int16 ( uint8_t * buffer,
const int16_t v )
constexprnoexcept

Put the given int16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

See also
packed_t_alignment_cast

Definition at line 922 of file byte_util.hpp.

◆ put_int16() [2/2]

void jau::put_int16 ( uint8_t * buffer,
const int16_t v,
const lb_endian_t byte_order )
constexprnoexcept

Put the given uint16_t value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

The value is converted from lb_endian::native to either lb_endian::little or lb_endian::big depending on given byte_order before it is stored in memory.

See also
packed_t_alignment_cast

Definition at line 935 of file byte_util.hpp.

◆ get_int16() [1/2]

int16_t jau::get_int16 ( uint8_t const * buffer)
constexprnoexcept

Returns a int16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

See also
packed_t_alignment_cast

Definition at line 945 of file byte_util.hpp.

◆ get_int16() [2/2]

int16_t jau::get_int16 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

Returns a int16_t value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

The value is converted from either lb_endian::little or lb_endian::big depending on given byte_order to lb_endian::native before it is returned to the caller.

See also
packed_t_alignment_cast

Definition at line 958 of file byte_util.hpp.

◆ put_uint32() [1/2]

void jau::put_uint32 ( uint8_t * buffer,
const uint32_t v )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 967 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint32() [2/2]

void jau::put_uint32 ( uint8_t * buffer,
const uint32_t v,
const lb_endian_t byte_order )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 975 of file byte_util.hpp.

◆ get_uint32() [1/2]

uint32_t jau::get_uint32 ( uint8_t const * buffer)
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 983 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_uint32() [2/2]

uint32_t jau::get_uint32 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 991 of file byte_util.hpp.

◆ put_int32() [1/2]

void jau::put_int32 ( uint8_t * buffer,
const int32_t v )
constexprnoexcept

See put_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1000 of file byte_util.hpp.

◆ put_int32() [2/2]

void jau::put_int32 ( uint8_t * buffer,
const int32_t v,
const lb_endian_t byte_order )
constexprnoexcept

See put_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1008 of file byte_util.hpp.

◆ get_int32() [1/2]

int32_t jau::get_int32 ( uint8_t const * buffer)
constexprnoexcept

See get_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1016 of file byte_util.hpp.

◆ get_int32() [2/2]

int32_t jau::get_int32 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1024 of file byte_util.hpp.

◆ put_uint64() [1/2]

void jau::put_uint64 ( uint8_t * buffer,
const uint64_t & v )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1033 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint64() [2/2]

void jau::put_uint64 ( uint8_t * buffer,
const uint64_t & v,
const lb_endian_t byte_order )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1041 of file byte_util.hpp.

◆ get_uint64() [1/2]

uint64_t jau::get_uint64 ( uint8_t const * buffer)
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1049 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_uint64() [2/2]

uint64_t jau::get_uint64 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1057 of file byte_util.hpp.

◆ put_int64() [1/2]

void jau::put_int64 ( uint8_t * buffer,
const int64_t & v )
constexprnoexcept

See put_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1066 of file byte_util.hpp.

◆ put_int64() [2/2]

void jau::put_int64 ( uint8_t * buffer,
const int64_t & v,
const lb_endian_t byte_order )
constexprnoexcept

See put_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1074 of file byte_util.hpp.

◆ get_int64() [1/2]

int64_t jau::get_int64 ( uint8_t const * buffer)
constexprnoexcept

See get_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1082 of file byte_util.hpp.

◆ get_int64() [2/2]

int64_t jau::get_int64 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_int16() for reference.

See also
packed_t_alignment_cast

Definition at line 1090 of file byte_util.hpp.

◆ put_uint128() [1/2]

void jau::put_uint128 ( uint8_t * buffer,
const uint128dp_t & v )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1099 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint128() [2/2]

void jau::put_uint128 ( uint8_t * buffer,
const uint128dp_t & v,
const lb_endian_t byte_order )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1107 of file byte_util.hpp.

◆ get_uint128() [1/2]

uint128dp_t jau::get_uint128 ( uint8_t const * buffer)
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1115 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_uint128() [2/2]

uint128dp_t jau::get_uint128 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1123 of file byte_util.hpp.

◆ put_uint192() [1/2]

void jau::put_uint192 ( uint8_t * buffer,
const uint192dp_t & v )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1132 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint192() [2/2]

void jau::put_uint192 ( uint8_t * buffer,
const uint192dp_t & v,
const lb_endian_t byte_order )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1140 of file byte_util.hpp.

◆ get_uint192() [1/2]

uint192dp_t jau::get_uint192 ( uint8_t const * buffer)
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1148 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_uint192() [2/2]

uint192dp_t jau::get_uint192 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1156 of file byte_util.hpp.

◆ put_uint256() [1/2]

void jau::put_uint256 ( uint8_t * buffer,
const uint256dp_t & v )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1165 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_uint256() [2/2]

void jau::put_uint256 ( uint8_t * buffer,
const uint256dp_t & v,
const lb_endian_t byte_order )
constexprnoexcept

See put_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1173 of file byte_util.hpp.

◆ get_uint256() [1/2]

uint256dp_t jau::get_uint256 ( uint8_t const * buffer)
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1181 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_uint256() [2/2]

uint256dp_t jau::get_uint256 ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

See get_uint16() for reference.

See also
packed_t_alignment_cast

Definition at line 1189 of file byte_util.hpp.

◆ put_value() [1/2]

template<typename T>
std::enable_if_t< std::is_standard_layout_v< T >, void > jau::put_value ( uint8_t * buffer,
const T & v )
constexprnoexcept

Put the given T value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

Template Parameters
T
Parameters
buffer
v
See also
packed_t_alignment_cast
Examples
test_basictypeconv.cpp.

Definition at line 1214 of file byte_util.hpp.

Here is the caller graph for this function:

◆ put_value() [2/2]

template<typename T>
std::enable_if_t< std::is_standard_layout_v< T >, void > jau::put_value ( uint8_t * buffer,
const T & v,
const lb_endian_t byte_order )
constexprnoexcept

Put the given T value into the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

The value is converted from lb_endian::native to either lb_endian::little or lb_endian::big depending on given byte_order before it is stored in memory.

Template Parameters
T
Parameters
buffer
v
byte_order
See also
packed_t_alignment_cast

Definition at line 1238 of file byte_util.hpp.

◆ get_value() [1/2]

template<typename T>
std::enable_if_t< std::is_standard_layout_v< T >, T > jau::get_value ( uint8_t const * buffer)
constexprnoexcept

Returns a T value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

Template Parameters
T
Parameters
buffer
Returns
See also
packed_t_alignment_cast
Examples
test_basictypeconv.cpp.

Definition at line 1257 of file byte_util.hpp.

Here is the caller graph for this function:

◆ get_value() [2/2]

template<typename T>
std::enable_if_t< std::is_standard_layout_v< T >, T > jau::get_value ( uint8_t const * buffer,
const lb_endian_t byte_order )
constexprnoexcept

Returns a T value from the given byte address using packed_t to resolve a potential memory alignment issue free of costs.

The value is converted from either lb_endian::little or lb_endian::big depending on given byte_order to lb_endian::native before it is returned to the caller.

Template Parameters
T
Parameters
buffer
byte_order
Returns
See also
packed_t_alignment_cast

Definition at line 1280 of file byte_util.hpp.

◆ dfa_utf8_decode() [1/2]

uint32_t jau::dfa_utf8_decode ( uint32_t & state,
uint32_t & codep,
const uint32_t byte_value )
Parameters
state
codep
byte_value
Returns

Definition at line 90 of file dfa_utf8_decode.cpp.

Here is the caller graph for this function:

◆ dfa_utf8_decode() [2/2]

std::string jau::dfa_utf8_decode ( const uint8_t * buffer,
const size_t buffer_size )

Returns all valid consecutive UTF-8 characters within buffer in the range up to buffer_size or until EOS.

In case a non UTF-8 character has been detected, the content will be cut off and the decoding loop ends.

Method utilizes a finite state machine detecting variable length UTF-8 codes. See Bjoern Hoehrmann's site http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ for details.

Definition at line 31 of file dfa_utf8_decode.cpp.

Variable Documentation

◆ has_endian_little_v

template<typename Dummy_type>
bool jau::has_endian_little_v = has_endian_little<Dummy_type>::value
constexpr

Value access of little-endian type trait for convenience .

Since all endian definitions are of constexpr, code can simply use expressions of these for compile-time evaluation and optimization. A template SFINAE is not required.

Template Parameters
Dummy_typejust to make template SFINAE happy
Examples
test_basictypeconv.cpp.

Definition at line 381 of file byte_util.hpp.

◆ has_endian_big_v

template<typename Dummy_type>
bool jau::has_endian_big_v = has_endian_big<Dummy_type>::value
constexpr

Value access of big-endian type trait for convenience .

Since all endian definitions are of constexpr, code can simply use expressions of these for compile-time evaluation and optimization. A template SFINAE is not required.

Template Parameters
Dummy_typejust to make template SFINAE happy

Definition at line 401 of file byte_util.hpp.