• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. _module-pw_bytes:
2
3---------
4pw_bytes
5---------
6pw_bytes is a collection of utilities for manipulating binary data.
7
8Compatibility
9=============
10C++17
11
12Dependencies
13============
14* ``pw_preprocessor``
15* ``pw_status``
16* ``pw_span``
17
18Features
19========
20
21pw_bytes/array.h
22----------------
23Functions for working with byte arrays, primarily for building fixed-size byte
24arrays at compile time.
25
26pw_bytes/byte_builder.h
27-----------------------
28.. cpp:class:: ByteBuilder
29
30  ``ByteBuilder`` is a class that facilitates building or reading arrays of
31  bytes in a fixed-size buffer. ByteBuilder handles reading and writing integers
32  with varying endianness.
33
34.. cpp:class:: template <size_t kMaxSize> ByteBuffer
35
36  ``ByteBuilder`` with an internally allocated buffer.
37
38Size report: using ByteBuffer
39^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40.. include:: byte_builder_size_report
41
42pw_bytes/endian.h
43-----------------
44Functions for converting the endianness of integral values.
45