coffee/continuable
1
0
Fork 0
mirror of https://github.com/Naios/continuable.git synced 2026-02-13 13:49:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add coroutine (await) usage support to the readme

Browse Source
This commit is contained in:
Denis Blank 2018-01-30 21:50:13 +01:00
parent 4b317fb964
commit fa273a3eac
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Readme.md
View File

@ -77,6 +77,7 @@ This library provides full feature support of:
- [Partial argument application](#partial-argument-application) - [Partial argument application](#partial-argument-application)
- [Dispatching callbacks through a specific executor](#dispatching-callbacks-through-a-specific-executor) - [Dispatching callbacks through a specific executor](#dispatching-callbacks-through-a-specific-executor)
- [Type erasure](#type-erasure) - [Type erasure](#type-erasure)
- [Coroutines](#coroutines)
- [Future conversion](#future-conversion) - [Future conversion](#future-conversion)
- [Compatibility](#compatibility) - [Compatibility](#compatibility)
- [Similar implementations and alternatives](#similar-implementations-and-alternatives) - [Similar implementations and alternatives](#similar-implementations-and-alternatives)
@ -380,6 +381,17 @@ my_continuation<int> myc = cti::make_continuable([](auto&& callback) {
We could also think about using `std::future` as backend but this is even worse then using `std::function` because usually there is, even more, type erasure and allocations involved. We could also think about using `std::future` as backend but this is even worse then using `std::function` because usually there is, even more, type erasure and allocations involved.
### Coroutines
Since version 2.0.0 coroutines (`co_await` and `co_return`) are supported by continuables when the underlying toolchain supports the TS. Currently this works in MSVC 2017 and Clang 5.0.
You have to enable this capability through the `CTI_CONTINUABLE_WITH_AWAIT` define in CMake.
```c++
int i = co_await cti::make_continuable<int>([](auto&& callback) {
callback.set_value(0);
});
```
### Future conversion ### Future conversion
The library is capable of converting (*futurizing*) every continuable into a fitting **std::future** through the `continuable<...>::futurize()` method.: The library is capable of converting (*futurizing*) every continuable into a fitting **std::future** through the `continuable<...>::futurize()` method.:
@ -444,7 +456,7 @@ The continuable library is licensed under the MIT License:
https://github.com/Naios/continuable https://github.com/Naios/continuable
v2.0.0 v2.0.0
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2018 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal of this software and associated documentation files(the "Software"), to deal