forked from boostorg/static_string
Add doc exposition and tidy
This commit is contained in:
Vinnie Falco committed
1 parent
7804cf80b8
commit
4f39500d47
3 files changed
+106
-11
No files matched your search
@@ -2,7 +2,52 @@
|
||||
|
||||
Branch | Travis | Appveyor | Azure Pipelines | codecov.io | Docs | Matrix |
|
||||
:-------------: | ------ | -------- | --------------- | ---------- | ---- | ------ |
|
||||
[`master`](https://github.com/boostorg/fixed_string/tree/master) | [](https://travis-ci.org/boostorg/fixed_string) | [](https://ci.appveyor.com/project/maintainer/fixed_string-xyzzy/branch/master) | [](https://dev.azure.com/maintainer/fixed_string/_build/latest?definitionId=6&branchName=master) | [](https://codecov.io/gh/boostorg/fixed_string/branch/master) | [](http://www.boost.org/doc/libs/master/doc/html/fixed_string.html) | [](http://www.boost.org/development/tests/master/developer/fixed_string.html)
|
||||
[`develop`](https://github.com/boostorg/fixed_string/tree/develop) | [](https://travis-ci.org/boostorg/fixed_string) | [](https://ci.appveyor.com/project/maintainer/fixed_string-xyzzy/branch/develop) | [](https://dev.azure.com/maintainer/fixed_string/_build/latest?definitionId=6&branchName=master) | [](https://codecov.io/gh/boostorg/fixed_string/branch/develop) | [](http://www.boost.org/doc/libs/develop/doc/html/fixed_string.html) | [](http://www.boost.org/development/tests/develop/developer/fixed_string.html)
|
||||
[`master`](https://github.com/vinniefalco/fixed_string/tree/master) | [](https://travis-ci.org/vinniefalco/fixed_string) | [](https://ci.appveyor.com/project/vinniefalco/fixed-string/branch/master) | [](https://dev.azure.com/vinniefalco/fixed-string/_build/latest?definitionId=6&branchName=master) | [](https://codecov.io/gh/vinniefalco/fixed_string/branch/master) | [](http://www.boost.org/doc/libs/master/doc/html/fixed_string.html) | [](http://www.boost.org/development/tests/master/developer/fixed_string.html)
|
||||
[`develop`](https://github.com/vinniefalco/fixed_string/tree/develop) | [](https://travis-ci.org/vinniefalco/fixed_string) | [](https://ci.appveyor.com/project/vinniefalco/fixed-string/branch/develop) | [](https://dev.azure.com/vinniefalco/fixed-string/_build/latest?definitionId=6&branchName=master) | [](https://codecov.io/gh/vinniefalco/fixed_string/branch/develop) | [](http://www.boost.org/doc/libs/develop/doc/html/fixed_string.html) | [](http://www.boost.org/development/tests/develop/developer/fixed_string.html)
|
||||
|
||||
This is currently **NOT** an official Boost library.
|
||||
## This is currently **NOT** an official Boost library.
|
||||
|
||||
## Introduction
|
||||
|
||||
This library provides a dynamically resizable string of characters with
|
||||
compile-time fixed capacity and contiguous embedded storage in which the
|
||||
characters are placed within the string object itself. Its API closely
|
||||
resembles that of `std::string`
|
||||
|
||||
## Motivation
|
||||
|
||||
A fixed capacity string is useful when:
|
||||
|
||||
* Memory allocation is not possible, e.g., embedded environments without a free
|
||||
store, where only a stack and the static memory segment are available.
|
||||
* Memory allocation imposes an unacceptable performance penalty.
|
||||
e.g., with respect to latency.
|
||||
* Allocation of objects with complex lifetimes in the static-memory
|
||||
segment is required.
|
||||
* A dynamically-resizable string is required within `constexpr` functions.
|
||||
* The storage location of the static_vector elements is required to be
|
||||
within the string object itself (e.g. to support memcopy for serialization
|
||||
purposes).
|
||||
|
||||
## Design
|
||||
|
||||
The over-arching design goal is to resemble the interface and behavior of
|
||||
`std::string` as much as possible. When any operation would exceed the
|
||||
maximum allowed size of the string, `std::length_error` is thrown. All
|
||||
algorithms which throw exceptions provide the strong exception safety
|
||||
guarantee.
|
||||
|
||||
## Iterators
|
||||
|
||||
The iterator invalidation rules are different than those for `std::string`,
|
||||
since:
|
||||
|
||||
* Moving a string invalidates all iterators
|
||||
* Swapping two strings invalidates all iterators
|
||||
|
||||
|
||||
## License
|
||||
|
||||
Distributed under the Boost Software License, Version 1.0.
|
||||
(See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at
|
||||
https://www.boost.org/LICENSE_1_0.txt)
|
||||
Reference in new issue
Block a user