mirror/magic_enum
1
0
Fork 0
mirror of https://github.com/Neargye/magic_enum.git synced 2026-01-09 23:34:23 +00:00
Code Activity

move iostream_operators to magic_enum_iostream

Browse source
This commit is contained in:
neargye 2023-05-21 17:49:46 +04:00
parent 57d7e79530
commit ed43fd5fa2
8 changed files with 148 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/reference.md
View file

@ -19,6 +19,7 @@
* [`is_scoped_enum` checks whether type is an Scoped enumeration.](#is_scoped_enum)
* [`underlying_type` improved UB-free "SFINAE-friendly" underlying_type.](#underlying_type)
* [`ostream_operators` ostream operators for enums.](#ostream_operators)
* [`istream_operators` istream operators for enums.](#istream_operators)
* [`bitwise_operators` bitwise operators for enums.](#bitwise_operators)
* [`containers::array` array container for enums.](#containersarray)
* [`containers::bitset` bitset container for enums.](#containersbitset)
@ -511,9 +512,10 @@ basic_ostream<Char, Traits>& operator<<(basic_ostream<Char, Traits>& os, E value
template <typename Char, typename Traits, typename E>
basic_ostream<Char, Traits>& operator<<(basic_ostream<Char, Traits>& os, optional<E> value);
```
* You should add the required file `<magic_enum_iostream.hpp>`.
* Out-of-the-box ostream operators for all enums.
* Examples
@ -524,6 +526,25 @@ basic_ostream<Char, Traits>& operator<<(basic_ostream<Char, Traits>& os, optiona
std::cout << color << std::endl; // "BLUE"
```
## `istream_operators`
```cpp
template <typename Char, typename Traits, typename E>
basic_istream<Char, Traits>& operator>>(basic_istream<Char, Traits>& is, E& value);
```
* You should add the required file `<magic_enum_iostream.hpp>`.
* Out-of-the-box istream operators for all enums.
* Examples
```cpp
using namespace magic_enum::istream_operators; // out-of-the-box istream operators for enums.
Color color;
std::cin >> color;
```
## `bitwise_operators`
```cpp