para/GSL
1
0
Fork 0
mirror of https://github.com/microsoft/GSL.git synced 2025-04-02 09:18:33 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge 5f0ff1d57bf248c5966433f55615becb8e65647c into 4742bc192a8561c96942fa23335502b4987522fb

Browse Source
This commit is contained in:
apenn-msft 2025-02-13 22:43:39 +08:00 committed by GitHub
commit 56d8937ca6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -50,7 +50,7 @@ dyn_array | &#x26
[**4. Utilities**][cg-utilities] | | [**4. Utilities**][cg-utilities] | |
move_owner | ☐ | A helper function that moves one `owner` to the other move_owner | ☐ | A helper function that moves one `owner` to the other
[byte](docs/headers.md#user-content-H-byte-byte) | ☑ | Either an alias to `std::byte` or a byte type [byte](docs/headers.md#user-content-H-byte-byte) | ☑ | Either an alias to `std::byte` or a byte type
[final_action](docs/headers.md#user-content-H-util-final_action) | ☑ | A RAII style class that invokes a functor on its destruction [final_action](docs/headers.md#user-content-H-util-final_action) | ☑ | A RAII style class that invokes a non-throwing functor on its destruction
[finally](docs/headers.md#user-content-H-util-finally) | ☑ | A helper function instantiating [final_action](docs/headers.md#user-content-H-util-final_action) [finally](docs/headers.md#user-content-H-util-finally) | ☑ | A helper function instantiating [final_action](docs/headers.md#user-content-H-util-final_action)
[GSL_SUPPRESS](docs/headers.md#user-content-H-assert-gsl_suppress) | ☑ | A macro that takes an argument and turns it into `[[gsl::suppress(x)]]` or `[[gsl::suppress("x")]]` [GSL_SUPPRESS](docs/headers.md#user-content-H-assert-gsl_suppress) | ☑ | A macro that takes an argument and turns it into `[[gsl::suppress(x)]]` or `[[gsl::suppress("x")]]`
[[implicit]] | ☐ | A "marker" to put on single-argument constructors to explicitly make them non-explicit [[implicit]] | ☐ | A "marker" to put on single-argument constructors to explicitly make them non-explicit

6
docs/headers.md
View File

@ -802,7 +802,7 @@ template <class F>
class final_action { ... }; class final_action { ... };
``` ```
`final_action` allows you to ensure something gets run at the end of a scope. `final_action` allows you to ensure non-throwing code is executed at the end of a scope.
See [E.19: Use a final_action object to express cleanup if no suitable resource handle is available](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Re-finally) See [E.19: Use a final_action object to express cleanup if no suitable resource handle is available](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Re-finally)
@ -813,13 +813,13 @@ explicit final_action(const F& ff) noexcept;
explicit final_action(F&& ff) noexcept; explicit final_action(F&& ff) noexcept;
``` ```
Construct an object with the action to invoke in the destructor. Construct an object with the non-throwing action to invoke in the destructor.
```cpp ```cpp
~final_action() noexcept; ~final_action() noexcept;
``` ```
The destructor will call the action that was passed in the constructor. The destructor will invoke the action that was passed in the constructor; if the action throws an exception the program will terminate.
```cpp ```cpp
final_action(final_action&& other) noexcept; final_action(final_action&& other) noexcept;

2
include/gsl/util
View File

@ -69,7 +69,7 @@ namespace gsl
// index type for all container indexes/subscripts/sizes // index type for all container indexes/subscripts/sizes
using index = std::ptrdiff_t; using index = std::ptrdiff_t;
// final_action allows you to ensure something gets run at the end of a scope // final_action allows you to ensure non-throwing code is executed at the end of a scope.
template <class F> template <class F>
class final_action class final_action
{ {