TartanLlama/optional
1
0
Fork 1
mirror of https://github.com/TartanLlama/optional.git synced 2025-07-30 09:57:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Simon Brand
2017-12-18 10:21:46 +00:00
parent 717027db9b
commit 632bc4e1ad
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,5 +1,5 @@
# optional # optional
Single header implementation of `std::optional` with functional-style extensions. Single header implementation of `std::optional` with functional-style extensions and support for references.
Clang + GCC: [![Linux Build Status](https://travis-ci.org/TartanLlama/optional.png?branch=master)](https://travis-ci.org/TartanLlama/optional) Clang + GCC: [![Linux Build Status](https://travis-ci.org/TartanLlama/optional.png?branch=master)](https://travis-ci.org/TartanLlama/optional)
MSVC: [![Windows Build Status](https://ci.appveyor.com/api/projects/status/k5x00xa11y3s5wsg?svg=true)](https://ci.appveyor.com/project/TartanLlama/optional) MSVC: [![Windows Build Status](https://ci.appveyor.com/api/projects/status/k5x00xa11y3s5wsg?svg=true)](https://ci.appveyor.com/project/TartanLlama/optional)
@ -66,6 +66,26 @@ The interface is the same as `std::optional`, but the following member functions
- `take`: returns the current value, leaving the optional empty. - `take`: returns the current value, leaving the optional empty.
* `opt_string.take().map(&std::string::size); //opt_string now empty;` * `opt_string.take().map(&std::string::size); //opt_string now empty;`
In addition to those member functions, optional references are also supported:
```
int i = 42;
tl::optional<int&> o = i;
*o == 42; //true
i = 12;
*o = 12; //true
&*o == &i; //true
```
Assignment has rebind semantics rather than assign-through semantics:
```
int j = 8;
o = j;
&*o == &j; //true
```
### Compiler support ### Compiler support
Tested on: Tested on: