mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-21 06:12:09 +00:00
f9fb90f299
- Update labels so they use consistent naming. Instead of the copy-and-pasted `chapter` prefix, name labels with a prefix consistent with what they point to: - "module-" for module - "target-" for targets - "docs-" for general documentation - Remove the unnecessary highlight and default-domain directives. Neither is necessary since the Pigweed docs always specify the language in code snippets and other directives. Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328 Commit-Queue: Wyatt Hepler <hepler@google.com> Reviewed-by: Keir Mierle <keir@google.com>
45 lines
957 B
ReStructuredText
45 lines
957 B
ReStructuredText
.. _module-pw_bytes:
|
|
|
|
---------
|
|
pw_bytes
|
|
---------
|
|
pw_bytes is a collection of utilities for manipulating binary data.
|
|
|
|
Compatibility
|
|
=============
|
|
C++17
|
|
|
|
Dependencies
|
|
============
|
|
* ``pw_preprocessor``
|
|
* ``pw_status``
|
|
* ``pw_span``
|
|
|
|
Features
|
|
========
|
|
|
|
pw_bytes/array.h
|
|
----------------
|
|
Functions for working with byte arrays, primarily for building fixed-size byte
|
|
arrays at compile time.
|
|
|
|
pw_bytes/byte_builder.h
|
|
-----------------------
|
|
.. cpp:class:: ByteBuilder
|
|
|
|
``ByteBuilder`` is a class that facilitates building or reading arrays of
|
|
bytes in a fixed-size buffer. ByteBuilder handles reading and writing integers
|
|
with varying endianness.
|
|
|
|
.. cpp:class:: template <size_t max_size> ByteBuffer
|
|
|
|
``ByteBuilder`` with an internally allocated buffer.
|
|
|
|
Size report: using ByteBuffer
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
.. include:: byte_builder_size_report
|
|
|
|
pw_bytes/endian.h
|
|
-----------------
|
|
Functions for converting the endianness of integral values.
|