ADTF  3.18.4
memory/memory.h
Go to the documentation of this file.
1 
15 #ifndef _A_UTILS_UTIL_MEMORY_MEMORY_INCLUDED_
16 #define _A_UTILS_UTIL_MEMORY_MEMORY_INCLUDED_
17 
18 #include <cstddef>
19 #include <cstdint>
20 
21 namespace a_util {
22 namespace memory {
23 class MemoryBuffer;
24 
34 bool copy(void* dest, std::size_t dest_size, const void* source, std::size_t bytes_to_copy);
35 
43 bool copy(void* dest, const void* source, std::size_t bytes_to_copy);
44 
52 bool copy(MemoryBuffer& buffer, const void* source, std::size_t bytes_to_copy);
53 
62 bool set(void* dest, std::size_t dest_size, std::uint8_t value, std::size_t bytes_to_set);
63 
71 bool set(void* dest, std::uint8_t value, std::size_t bytes_to_set);
72 
80 bool set(MemoryBuffer& buffer, std::uint8_t value, std::size_t bytes_to_set);
81 
89 bool zero(void* dest, std::size_t dest_size, std::size_t bytes_to_zero);
90 
97 bool zero(void* dest, std::size_t bytes_to_zero);
98 
105 bool zero(MemoryBuffer& buffer, std::size_t bytes_to_zero);
106 
118 int compare(const void* buf1, std::size_t buf1_size, const void* buf2, std::size_t buf2_size);
119 
126 bool isZero(const void* buffer, std::size_t buffer_size);
127 
132 bool swapEndianess(bool value);
134 std::int8_t swapEndianess(std::int8_t value);
136 std::uint8_t swapEndianess(std::uint8_t value);
138 std::int16_t swapEndianess(std::int16_t value);
140 std::uint16_t swapEndianess(std::uint16_t value);
142 std::int32_t swapEndianess(std::int32_t value);
144 std::uint32_t swapEndianess(std::uint32_t value);
146 std::int64_t swapEndianess(std::int64_t value);
148 std::uint64_t swapEndianess(std::uint64_t value);
149 
150 } // namespace memory
151 } // namespace a_util
152 
153 #endif // _A_UTILS_UTIL_MEMORY_MEMORY_INCLUDED_
Memory buffer class to encapsulate and manage raw contiguously memory.
Definition: memorybuffer.h:23
bool swapEndianess(bool value)
Swap the byte order of parameter value.
int compare(const void *buf1, std::size_t buf1_size, const void *buf2, std::size_t buf2_size)
Portable safe memcmp.
bool set(void *dest, std::size_t dest_size, std::uint8_t value, std::size_t bytes_to_set)
Portable safe memset.
bool isZero(const void *buffer, std::size_t buffer_size)
Check whether the given memory range is entirely zero-initialized.
bool copy(void *dest, std::size_t dest_size, const void *source, std::size_t bytes_to_copy)
Portable safe memcopy.
bool zero(void *dest, std::size_t dest_size, std::size_t bytes_to_zero)
Portable safe memzero.
Serves as the root component, with common functionality documented in core functionality.
Definition: base.h:24