feedc0de/boost_system
1
0
Fork 0
forked from boostorg/system
Code Pull Requests Activity

Update documentation

Browse Source
This commit is contained in:
Peter Dimov
2021-10-02 01:39:06 +03:00
parent 0ccf08509b
commit f2d3a0decf
1 changed files with 38 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
doc/system/reference.adoc
View File

@ -571,9 +571,13 @@ public:
error_code( int val, const error_category & cat, error_code( int val, const error_category & cat,
boost::source_location const * loc ) noexcept; boost::source_location const * loc ) noexcept;
template <class ErrorCodeEnum> template<class ErrorCodeEnum>
constexpr error_code( ErrorCodeEnum e ) noexcept; constexpr error_code( ErrorCodeEnum e ) noexcept;
template<class ErrorCodeEnum>
error_code( ErrorCodeEnum e, boost::source_location const * loc )
noexcept;
error_code( std::error_code const& ec ) noexcept; error_code( std::error_code const& ec ) noexcept;
// modifiers // modifiers
@ -583,9 +587,13 @@ public:
void assign( int val, const error_category & cat, void assign( int val, const error_category & cat,
boost::source_location const * loc ) noexcept; boost::source_location const * loc ) noexcept;
template<typename ErrorCodeEnum> template<class ErrorCodeEnum>
constexpr error_code & operator=( ErrorCodeEnum e ) noexcept; constexpr error_code & operator=( ErrorCodeEnum e ) noexcept;
template<class ErrorCodeEnum>
void assign( ErrorCodeEnum e,
boost::source_location const * loc ) noexcept;
constexpr void clear() noexcept; constexpr void clear() noexcept;
// observers // observers
@ -657,7 +665,7 @@ public:
// stream insertion // stream insertion
template <class charT, class traits> template<class charT, class traits>
friend std::basic_ostream<charT, traits>& friend std::basic_ostream<charT, traits>&
operator<<( basic_ostream<charT, traits>& os, const error_code & ec ); operator<<( basic_ostream<charT, traits>& os, const error_code & ec );
}; };
@ -699,7 +707,7 @@ Requires: :: `loc` points to a valid `boost::source_location` object with static
Ensures: :: `value() == val`; `category() == cat`; `has_location()`; `&location() == loc`. Ensures: :: `value() == val`; `category() == cat`; `has_location()`; `&location() == loc`.
``` ```
template <class ErrorCodeEnum> template<class ErrorCodeEnum>
constexpr error_code( ErrorCodeEnum e ) noexcept; constexpr error_code( ErrorCodeEnum e ) noexcept;
``` ```
[none] [none]
@ -708,6 +716,19 @@ template <class ErrorCodeEnum>
Ensures: :: `*this == make_error_code( e )`. Ensures: :: `*this == make_error_code( e )`.
Remarks: :: This constructor is only enabled when `is_error_code_enum<ErrorCodeEnum>::value` is `true`. Remarks: :: This constructor is only enabled when `is_error_code_enum<ErrorCodeEnum>::value` is `true`.
```
template<class ErrorCodeEnum>
error_code( ErrorCodeEnum e, boost::source_location const * loc ) noexcept;
```
[none]
* {blank}
+
Requires: :: `loc` points to a valid `boost::source_location` object with static storage duration.
Ensures: :: `*this == make_error_code( e )`.
Remarks: :: This constructor is only enabled when `is_error_code_enum<ErrorCodeEnum>::value` is `true`.
When `make_error_code( e )` is not a default-constructed `error_code` and doesn't wrap a
`std::error_code`, `has_location()` is `true` and `&location()` is `loc`.
``` ```
error_code( std::error_code const & ec ) noexcept; error_code( std::error_code const & ec ) noexcept;
``` ```
@ -737,7 +758,7 @@ void assign( int val, const error_category & cat,
Effects: :: `*this = error_code( val, cat, loc )`. Effects: :: `*this = error_code( val, cat, loc )`.
``` ```
template<typename ErrorCodeEnum> template<class ErrorCodeEnum>
constexpr error_code & operator=( ErrorCodeEnum e ) noexcept; constexpr error_code & operator=( ErrorCodeEnum e ) noexcept;
``` ```
[none] [none]
@ -746,6 +767,18 @@ template<typename ErrorCodeEnum>
Ensures: :: `*this == make_error_code( e )`. Ensures: :: `*this == make_error_code( e )`.
Remarks: :: This operator is only enabled when `is_error_code_enum<ErrorCodeEnum>::value` is `true`. Remarks: :: This operator is only enabled when `is_error_code_enum<ErrorCodeEnum>::value` is `true`.
```
template<class ErrorCodeEnum>
void assign( ErrorCodeEnum e,
boost::source_location const * loc ) noexcept;
```
[none]
* {blank}
+
Requires: :: `loc` points to a valid `boost::source_location` object with static storage duration.
Effects: :: `*this = error_code( e, loc )`.
Remarks: :: This function is only enabled when `is_error_code_enum<ErrorCodeEnum>::value` is `true`.
``` ```
constexpr void clear() noexcept; constexpr void clear() noexcept;
``` ```