4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
4.9 KiB
| title |
|---|
| byte_stream_reader |
{{< callout type="info">}}
Header: byte_stream_reader.h
From: 20.17.0
{{< /callout >}}
A binary streaming utility that allows boolean, integral and floating point values to be read from an array of char or unsigned char. By default, values are stored in the byte stream in network order (Big Endian). This can be changed by specifying in the constructor.
class byte_stream_reader
Note for floating point: Be aware that floating point representations can change between platforms.
For example,long doubleis 8 bytes for MS compilers and 12 for GCC.
Types
iterator char*
const_iterator const char*
Constructors
byte_stream_reader(etl::span<char> span, etl::endian stream_endianness)
Description
Construct from span.
byte_stream_reader(etl::span<const char> span, etl::endian stream_endianness)
Description
Construct from span.
byte_stream_reader(const void* begin, const void* end, etl::endian stream_endianness)
Description
Construct from range.
byte_stream_reader(const void* begin, size_t length, etl::endian stream_endianness)
Description
Construct from begin and length.
template <typename T, size_t Size>
byte_stream_reader(T(&begin)[Size], etl::endian stream_endianness)
Description
Construct from array.
template <typename T, size_t Size>
byte_stream_reader(const T(&begin)[Size], etl::endian stream_endianness)
Description
Construct from const array.
Read
Checked
The following functions will only read from the buffer if there is enough room to do so.
template <typename T>
etl::optional<T> read()
Description
Read an integral value from the stream.
template <typename T>
etl::optional<etl::span<T>> read(size_t n)
Description
Read a byte range from the stream.
template <typename T>
etl::optional<etl::span<const T>> read(etl::span<T> range)
Description
Read a range of T from the stream.
template <typename T>
etl::optional<etl::span<const T>> read(const T* start, size_t length)
Description
Read a range of T from the stream.
Unchecked
From: 20.18.0
The following functions will always read from the buffer. They do not check for free space.
template <typename T>
etl::optional<T> read_unchecked()
Description
Read an integral value from the stream.
template <typename T>
etl::optional<etl::span<T>> read_unchecked(size_t n)
Description
Read a byte range from the stream.
template <typename T>
etl::optional<etl::span<const T>> read_unchecked(etl::span<T> range)
Description
Read a range of T from the stream.
template <typename T>
etl::optional<etl::span<const T>> read_unchecked(T* start, size_t length)
Description
Read a range of T from the stream.
Status
bool empty() const
Description
Returns true if the byte stream is empty.
size_t size_bytes() const
Description
Returns the number of bytes used in the stream.
template <typename T>
size_t available() const
Description
The number of T left in the stream.
Access
void restart(size_t n = 0U)
Description
Sets the index back to position n in the stream. Default = 0.
template <typename T>
bool skip(size_t n)
Description
Skip n items of T, if the total space is available.
Returns true if the skip was possible.
Returns false if the full skip size was not possible.
template <typename T>
bool skip(size_t n)
Description
Skip n items of T, if the total space is available.
Returns true if the skip was possible.
Asserts etl::byte_stream_overflow and returns false if the skip size was not possible.
From: 20.29.1
const_iterator begin() const
Description
Returns start of the stream.
const_iterator end() const
Description
Returns end of the stream.
const_iterator cbegin() const
Description
Returns start of the stream.
const_iterator cend() const
Description
Returns end of the stream.
etl::span<char> used_data() const
Description
Returns a span of the used portion of the stream.
etl::span<char> free_data() const
Description
Returns a span of the free portion of the stream.
etl::span<char> data() const
Description
Returns a span of whole the stream.
Non-member functions
Default implementation of the read functions.
For integral and floating point types only.
Specialise these to support custom types.
template <typename T> 20.18.0
T read_unchecked(etl::byte_stream_reader& stream)
template <typename T>
etl::optional<T> read(etl::byte_stream_reader& stream)