[#mp_units-basic_fixed_string-08]
= xref:mp_units.adoc[mp_units]::basic_fixed_string
:relfileprefix: ../
:mrdocs:

A compile‐time fixed string

== Synopsis

Declared in `<mp‐units/ext/fixed_string.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename CharT,
    std::size_t N>
class basic_fixed_string
    : public /* implementation-defined */
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `/* implementation-defined */`
| 
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/basic_fixed_string-08/const_iterator.adoc[`const_iterator`] 
| Constant iterator over the string's elements
| xref:mp_units/basic_fixed_string-08/const_pointer.adoc[`const_pointer`] 
| Pointer to a constant character of the string
| xref:mp_units/basic_fixed_string-08/const_reference.adoc[`const_reference`] 
| Reference to a constant character of the string
| xref:mp_units/basic_fixed_string-08/const_reverse_iterator.adoc[`const_reverse_iterator`] 
| Reverse iterator over the string's constant elements
| xref:mp_units/basic_fixed_string-08/difference_type.adoc[`difference_type`] 
| Signed integer type used to represent iterator differences
| xref:mp_units/basic_fixed_string-08/iterator.adoc[`iterator`] 
| Iterator type (same as `const_iterator`, as the string is immutable)
| xref:mp_units/basic_fixed_string-08/pointer.adoc[`pointer`] 
| Pointer to a character of the string
| xref:mp_units/basic_fixed_string-08/reference.adoc[`reference`] 
| Reference to a character of the string
| xref:mp_units/basic_fixed_string-08/reverse_iterator.adoc[`reverse_iterator`] 
| Reverse iterator type (same as `const_reverse_iterator`, as the string is immutable)
| xref:mp_units/basic_fixed_string-08/size_type.adoc[`size_type`] 
| Unsigned integer type used to represent sizes and indices
| xref:mp_units/basic_fixed_string-08/value_type.adoc[`value_type`] 
| The character type used by the string
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/basic_fixed_string-08/2constructor-01.adoc[`basic_fixed_string`]         [.small]#[constructor]#
| Constructors
| xref:mp_units/basic_fixed_string-08/operator_assign.adoc[`operator=`] 
| Copy assignment operator
| xref:mp_units/basic_fixed_string-08/at.adoc[`at`] 
| Accesses the character at the given position, with bounds checking
| xref:mp_units/basic_fixed_string-08/back.adoc[`back`] 
| The last character of the string.
| xref:mp_units/basic_fixed_string-08/begin.adoc[`begin`] 
| An iterator to the first character of the string.
| xref:mp_units/basic_fixed_string-08/c_str.adoc[`c_str`] 
| A pointer to a null‐terminated character array holding the string's contents.
| xref:mp_units/basic_fixed_string-08/cbegin.adoc[`cbegin`] 
| A constant iterator to the first character of the string.
| xref:mp_units/basic_fixed_string-08/cend.adoc[`cend`] 
| A constant iterator past the last character of the string.
| xref:mp_units/basic_fixed_string-08/crbegin.adoc[`crbegin`] 
| A constant reverse iterator to the last character of the string.
| xref:mp_units/basic_fixed_string-08/crend.adoc[`crend`] 
| A constant reverse iterator preceding the first character of the string.
| xref:mp_units/basic_fixed_string-08/data.adoc[`data`] 
| A pointer to the underlying null‐terminated character array.
| xref:mp_units/basic_fixed_string-08/end.adoc[`end`] 
| An iterator past the last character of the string.
| xref:mp_units/basic_fixed_string-08/front.adoc[`front`] 
| The first character of the string.
| xref:mp_units/basic_fixed_string-08/operator_subs.adoc[`operator[]`] 
| Accesses the character at the given position, without bounds checking
| xref:mp_units/basic_fixed_string-08/rbegin.adoc[`rbegin`] 
| A reverse iterator to the last character of the string.
| xref:mp_units/basic_fixed_string-08/rend.adoc[`rend`] 
| A reverse iterator preceding the first character of the string.
| xref:mp_units/basic_fixed_string-08/swap.adoc[`swap`] 
| Exchanges the contents of this string with those of `s`
| xref:mp_units/basic_fixed_string-08/view.adoc[`view`] 
| A `std::basic_string_view` over the string's contents.
| xref:mp_units/basic_fixed_string-08/2conversion.adoc[`operator std::basic_string_view<CharT>`] 
| Implicit conversion to a `std::basic_string_view` over the string's contents.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/basic_fixed_string-08/data_.adoc[`data_`] 
| The underlying null‐terminated character storage (exposition only)
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/basic_fixed_string-08/empty.adoc[`empty`] 
| Whether the string holds no characters
| xref:mp_units/basic_fixed_string-08/length.adoc[`length`] 
| The number of characters in the string (same as `size`)
| xref:mp_units/basic_fixed_string-08/max_size.adoc[`max_size`] 
| The maximum number of characters the string can hold (same as `size`, since the length is fixed)
| xref:mp_units/basic_fixed_string-08/size.adoc[`size`] 
| The number of characters in the string
|===


== Deduction Guides

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/basic_fixed_string-0f.adoc[`basic_fixed_string<CharT, 1 + sizeof...(Rest)>`] 
| Deduces `basic_fixed_string` from a pack of individual characters
| xref:mp_units/basic_fixed_string-07.adoc[`basic_fixed_string<CharT, N>`] 
| Deduces `basic_fixed_string` from a `std::array` of characters
| xref:mp_units/basic_fixed_string-0d.adoc[`basic_fixed_string<CharT, N ‐ 1>`] 
| Deduces `basic_fixed_string` from a null‐terminated character array literal
|===


== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *CharT*
| Character type to be used by the string
| *N*
| The size of the string
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#