aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Maples <jomaples@microsoft.com>2020-10-01 14:38:41 -0700
committerJordan Maples <jomaples@microsoft.com>2020-10-01 14:38:41 -0700
commit1665f07cf67b2d6294e3877cfd3f16739b438e8a (patch)
tree2b057412dfa0fa8cfe02df197bf88fe2064d46b5
parent3f68a0034a4ab73f1bf21dae2be8895e81e16ab0 (diff)
downloadMicrosoft-GSL-1665f07cf67b2d6294e3877cfd3f16739b438e8a.tar.gz
updating readme to reflect the deprecation of string_span
-rw-r--r--README.md42
1 files changed, 21 insertions, 21 deletions
diff --git a/README.md b/README.md
index c3005c4..3aaf8b8 100644
--- a/README.md
+++ b/README.md
@@ -27,27 +27,8 @@ Feature | Supported? | Description
[**1. Views**][cg-views] | |
owner | &#x2611; | an alias for a raw pointer
not_null | &#x2611; | restricts a pointer / smart pointer to hold non-null values
-strict_not_null | &#x2611; | a stricter version of `not_null` with explicit constructors
span | &#x2611; | a view over a contiguous sequence of memory. Based on the standardized verison of `std::span`, however `gsl::span` enforces bounds checking. See the [wiki](https://github.com/microsoft/GSL/wiki/gsl::span-and-std::span) for additional information.
span_p | &#x2610; | spans a range starting from a pointer to the first place for which the predicate is true
-basic_zstring | &#x2611; | a pointer to a C-string (zero-terminated array) with a templated char type
-zstring | &#x2611; | an alias to `basic_zstring` with a char type of char
-czstring | &#x2611; | an alias to `basic_zstring` with a char type of const char
-wzstring | &#x2611; | an alias to `basic_zstring` with a char type of wchar_t
-cwzstring | &#x2611; | an alias to `basic_zstring` with a char type of const wchar_t
-u16zstring | &#x2611; | an alias to `basic_zstring` with a char type of char16_t
-cu16zstring | &#x2611; | an alias to `basic_zstring` with a char type of const char16_t
-u32zstring | &#x2611; | an alias to `basic_zstring` with a char type of char32_t
-cu32zstring | &#x2611; | an alias to `basic_zstring` with a char type of const char32_t
-basic_string_span | &#x2611; | like `span` but for strings with a templated char type
-string_span | &#x2611; | an alias to `basic_string_span` with a char type of char
-cstring_span | &#x2611; | an alias to `basic_string_span` with a char type of const char
-wstring_span | &#x2611; | an alias to `basic_string_span` with a char type of wchar_t
-cwstring_span | &#x2611; | an alias to `basic_string_span` with a char type of const wchar_t
-u16string_span | &#x2611; | an alias to `basic_string_span` with a char type of char16_t
-cu16string_span | &#x2611; | an alias to `basic_string_span` with a char type of const char16_t
-u32string_span | &#x2611; | an alias to `basic_string_span` with a char type of char32_t
-cu32string_span | &#x2611; | an alias to `basic_string_span` with a char type of const char32_t
[**2. Owners**][cg-owners] | |
unique_ptr | &#x2611; | an alias to `std::unique_ptr`
shared_ptr | &#x2611; | an alias to `std::shared_ptr`
@@ -70,11 +51,30 @@ narrow_cast | &#x2611; | a narrowing cast for values an
narrowing_error | &#x2611; | a custom exception type thrown by `narrow()`
[**5. Concepts**][cg-concepts] | &#x2610; |
-## The following features do not exist in C++ Core Guidelines:
+## The following features do not exist in or have been removed from the C++ Core Guidelines:
Feature | Supported? | Description
-----------------------------------|:----------:|-------------
-multi_span | &#x2610; | Deprecated. Support for this type has been discontinued.
+strict_not_null | &#x2611; | A stricter version of `not_null` with explicit constructors
+multi_span | &#x2610; | Deprecated. Multi-dimensional span.
strided_span | &#x2610; | Deprecated. Support for this type has been discontinued.
+basic_zstring | &#x2610; | Deprecated. A pointer to a C-string (zero-terminated array) with a templated char type
+zstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of char
+czstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of const char
+wzstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of wchar_t
+cwzstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of const wchar_t
+u16zstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of char16_t
+cu16zstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of const char16_t
+u32zstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of char32_t
+cu32zstring | &#x2610; | Deprecated. An alias to `basic_zstring` with a char type of const char32_t
+basic_string_span | &#x2610; | Deprecated. Like `span` but for strings with a templated char type
+string_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of char
+cstring_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of const char
+wstring_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of wchar_t
+cwstring_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of const wchar_t
+u16string_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of char16_t
+cu16string_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of const char16_t
+u32string_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of char32_t
+cu32string_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of const char32_t
This is based on [CppCoreGuidelines semi-specification](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#gsl-guidelines-support-library).