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-06-16 03:06:26 +03:00
parent 39a19f3c90
commit b41139b28e
1 changed files with 54 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
doc/system/reference.adoc
View File

@ -622,6 +622,16 @@ namespace boost {
friend bool operator!=( const std::error_code & lhs,
const error_code & rhs ) noexcept;
template<class E>
friend constexpr bool operator==( const error_code & lhs, E rhs ) noexcept;
template<class E>
friend constexpr bool operator==( E lhs, const error_code & rhs ) noexcept;
template<class E>
friend constexpr bool operator!=( const error_code & lhs, E rhs ) noexcept;
template<class E>
friend constexpr bool operator!=( E lhs, const error_code & rhs ) noexcept;
// conversions:
operator std::error_code() const;
@ -818,11 +828,11 @@ Returns: :: If `code` wraps a `std::error_code` object `ec`, `ec == static_cast<
Otherwise, `code.category().equivalent( code.value(), condition ) || condition.category().equivalent( code, condition.value() )`.
```
friend constexpr bool operator!=( const error_code & lhs,
friend bool operator!=( const error_code & lhs,
const error_condition & rhs ) noexcept;
```
```
friend constexpr bool operator!=( const error_condition & lhs,
friend bool operator!=( const error_condition & lhs,
const error_code & rhs ) noexcept;
```
[none]
@ -862,6 +872,48 @@ friend bool operator!=( const std::error_code & lhs,
Returns: ::
`!( lhs == rhs )`.
```
template<class E>
friend constexpr bool operator==( const error_code & lhs, E rhs ) noexcept;
```
[none]
* {blank}
+
Effects: ::
[disc]
** When `is_error_code_enum<E>::value` is `true`, returns `lhs == make_error_code(rhs)`;
** When `is_error_condition_enum<E>::value` is `true`, returns `lhs == make_error_condition(rhs)`;
** Otherwise, this overload is disabled.
```
template<class E>
friend constexpr bool operator==( E lhs, const error_code & rhs ) noexcept;
```
[none]
* {blank}
+
Effects: ::
[disc]
** When `is_error_code_enum<E>::value` is `true`, returns `make_error_code(lhs) == rhs`;
** When `is_error_condition_enum<E>::value` is `true`, returns `make_error_condition(lhs) == rhs`;
** Otherwise, this overload is disabled.
```
template<class E>
friend constexpr bool operator!=( const error_code & lhs, E rhs ) noexcept;
```
```
template<class E>
friend constexpr bool operator!=( E lhs, const error_code & rhs ) noexcept;
```
[none]
* {blank}
+
Returns: :: `!( lhs == rhs )`.
Remarks: :: These overloads are only enabled when
`is_error_code_enum<E>::value` is `true` or
`is_error_condition_enum<E>::value` is `true`.
#### Conversions
```