mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
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>
147 lines
2.9 KiB
Markdown
147 lines
2.9 KiB
Markdown
---
|
|
title: "string_stream"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `string_stream.h`
|
|
{{< /callout >}}
|
|
|
|
## Streaming types
|
|
`string_stream`
|
|
`wstring_stream`
|
|
`u16string_stream`
|
|
`u32string_stream`
|
|
|
|
Classes to build strings using a streaming API.
|
|
Uses `etl::basic_format_spec` to define the required formatting.
|
|
|
|
The documentation below is for `etl::string_stream`.
|
|
The other streams have a similar API, though using `w`, `u8`, `u16` or `u32` types.
|
|
|
|
## Member functions
|
|
```cpp
|
|
explicit string_stream(etl::istring& str)
|
|
```
|
|
**Description**
|
|
Construct, using the supplied string as a buffer.
|
|
Uses the default `format_spec`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
string_stream(etl::istring& str, const etl::format_spec& spec)
|
|
```
|
|
**Description**
|
|
Construct, using the supplied string as a buffer.
|
|
Initialised with the supplied `format_spec`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void set_format(const etl::format_spec& spec_)
|
|
```
|
|
**Description**
|
|
Sets a new `format_spec` to use.
|
|
|
|
---
|
|
|
|
```cpp
|
|
const etl::format_spec& get_format() const
|
|
```
|
|
**Description**
|
|
Gets the current `format_spec`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
etl::istring& str()
|
|
```
|
|
**Description**
|
|
Gets a reference to the internal string.
|
|
|
|
```cpp
|
|
const etl::istring& str() const
|
|
```
|
|
**Description**
|
|
Gets a const reference to the internal string.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void str(const etl::istring::const_pointer p)
|
|
```
|
|
**Description**
|
|
Resets the internal string to the text pointed to by `p`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void str(const etl::istring& text)
|
|
```
|
|
**Description**
|
|
Resets the internal string to `text`.
|
|
|
|
## Streaming operators
|
|
```cpp
|
|
string_stream& operator <<(string_stream& ss, T value)
|
|
```
|
|
**Description**
|
|
Where `T` may be one of the following:-
|
|
|
|
Any fundamental type.
|
|
`etl::format_spec`
|
|
`etl::setb0ase(n)`
|
|
`etl::bin`
|
|
`etl::oct`
|
|
`etl::dec`
|
|
`etl::hex`
|
|
`etl::setfill(c)`
|
|
`etl::setw(n)`
|
|
`etl::setprecision(n)`
|
|
`etl::left`
|
|
`etl::right`
|
|
`etl::boolalpha`
|
|
`etl::noboolalpha`
|
|
`etl::uppercase`
|
|
`etl::nouppercase`
|
|
`etl::showbase`
|
|
`etl::noshowbase`
|
|
`etl::string`
|
|
`etl::istring`
|
|
`etl::string_view`
|
|
`const char*`
|
|
|
|
See `etl::format_spec`
|
|
|
|
Custom user types may be streamed by overloading the streaming operator.
|
|
|
|
## Examples
|
|
|
|
### Using format_spec
|
|
```cpp
|
|
etl::format_spec format1 = etl::format_spec().hex().width(8).fill('0');
|
|
etl::format_spec format2;
|
|
etl::format_spec format3 = etl::format_spec().width(6).fill('#').precision(3);
|
|
etl::string<50> text;
|
|
etl::string_stream stream(text);
|
|
|
|
stream << format1 << 1193046 << format2 << " " << format3 << 3.1415;
|
|
const etl::istring& result = stream.str();
|
|
```
|
|
|
|
`text` is set to `"00123456 #3.142"`.
|
|
|
|
### Using stream manipulators
|
|
```cpp
|
|
etl::string<50> text;
|
|
etl::string_stream stream(text);
|
|
|
|
stream << etl::hex << etl::setw(8) << etl::setfill('0') << 1193046
|
|
<< etl::setw(0) << " "
|
|
<< etl::setw(6) << etl::setfill('#') << etl::setprecision(3) << 3.1415;
|
|
const etl::istring& result = stream.str();
|
|
```
|
|
|
|
`text` is set to `"00123456 #3.142"`.
|
|
|