para/GSL
1
0
Fork 0
mirror of https://github.com/microsoft/GSL.git synced 2024-11-03 17:56:43 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document span_ext (#1098)

Browse Source 
`<gsl/span>` is intended to mirror `<span>` in the STL. `<span_ext>` provides convenience features that aren't part of `<span>`.
Address #1095
This commit is contained in:
dmitrykobets-msft 2023-02-23 10:22:02 -08:00 committed by GitHub
parent 7f7108a076
commit 78eb6ca145
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/headers.md
View File

@ -599,7 +599,7 @@ Converts a `span` into a `span` of `byte`s.
## <a name="H-span_ext" />`<span_ext>` ## <a name="H-span_ext" />`<span_ext>`
This files is a companion for and included by [`<span>`](#user-content-H-span). This file is a companion for and included by [`<gsl/span>`](#user-content-H-span), and should not be used on its own. It contains useful features that aren't part of the `std::span` API as found inside the STL `<span>` header (with the exception of [`gsl::dynamic_extent`](#user-content-H-span_ext-dynamic_extent), which is included here due to implementation constraints).
- [`gsl::dynamic_extent`](#user-content-H-span_ext-dynamic_extent) - [`gsl::dynamic_extent`](#user-content-H-span_ext-dynamic_extent)
- [`gsl::span`](#user-content-H-span_ext-span) - [`gsl::span`](#user-content-H-span_ext-span)
@ -611,7 +611,9 @@ This files is a companion for and included by [`<span>`](#user-content-H-span).
### <a name="H-span_ext-dynamic_extent" />`gsl::dynamic_extent` ### <a name="H-span_ext-dynamic_extent" />`gsl::dynamic_extent`
Defines the extent value to be used by all `gsl::span` with dynamic extent. Defines the extent value to be used by all `gsl::span` with dynamic extent.
Note: `std::dynamic_extent` is exposed by the STL `<span>` header and so ideally `gsl::dynamic_extent` would be under [`<gsl/span>`](#user-content-H-span), but to avoid cyclic dependency issues it is under `<span_ext>` instead.
### <a name="H-span_ext-span" />`gsl::span` ### <a name="H-span_ext-span" />`gsl::span`