Work on RawStorage and StatusCode APIs

Author: Voltra

Doxymain.md

@@ -26,25 +26,26 @@ We will assume that the data is initially stored in a `std::vector`.
 
 #### Pure STL solution
 
-```
+```cpp
 template <class Predicate, class Action>
 void processActionIf(Predicate predicate, Action action){
-	std::vector<std::shared_ptr<GuiComponent>> components = GUI.getComponents();
-	for(GuiComponent& component : components){
+	for(std::shared_ptr<GuiComponent>& component : GUI.getComponents()){
 		if(predicate(component))
 			action(component);
-	}
+	} //raw loops :c
 }
 
 // OR
 
 template <class Predicate, class Action>
 void processActionIf(Predicate predicate, Action action){
 	std::vector<std::shared_ptr<GuiComponent>> components = GUI.getComponents();
+    
 	std::vector<std::shared_ptr<GuiComponent>> filtered;
-	
 	std::copy_if(begin(components), end(components), emplace_back(filtered), predicate);
 	std::for_each(begin(filtered), end(filtered), action);
+    
+    //if we had a std::do_if we wouldn't need a second vector
 }
 ```
 
@@ -56,7 +57,7 @@ In this simple use-case, using a for-loop reduces the amount of unnecessary copi
 
 #### Stream API
 
-```
+```cpp
 template <class Predicate, class Action>
 void processActionIf(Predicate predicate, Action action){	
 	streamFrom(GUI.getComponents())
@@ -117,13 +118,14 @@ You can have a look at `unique` to see how an operator is built on top of anothe
 
 Let's say you have
 
-```
+```cpp
 std::vector<SpecialElement> v = streamFrom(container)
 | map(&Element::getSpecialId)
 | unique()
 | filter(startsWith("s", Case::INSENSITIVE))
-| map(+[](const SpecialId& id){ return SpecialHub::from(id, Checks::NONE); })
-| pack::toVector();
+| map(+[](const SpecialId& id){
+    return SpecialHub::from(id, Checks::NONE);
+}) | pack::toVector();
 ```
 
 
@@ -132,7 +134,7 @@ std::vector<SpecialElement> v = streamFrom(container)
 
 This is roughly equivalent to
 
-```
+```cpp
 std::vector<SpecialElement> v;
 std::set<SpecialId> tagged;
 
@@ -173,7 +175,7 @@ The async API is a set of tools that abstract away all the burden of maintaining
 
 Used with `scl::async::with`, an abstraction over resource management (e.g. you could adapt it for the filesystem), it becomes one of the most useful tools to use the Monitor pattern :
 
-```c++
+```cpp
 #include "Queue.h"
 #include <scl/async/async.hpp>
 #include <scl/utils/utils.hpp>
@@ -182,7 +184,7 @@ using namespace scl::async;
 using namespace scl::utils;
 
 template <class T>
-class AsyncQueue{
+class AsyncQueue{ //kind of a Monitor
     protected:
     	Mutexed<Queue<T>> queue = {};
 
@@ -222,7 +224,7 @@ Why the use of functions instead of wrapping in a block? It's nicer to read and
 
 * you need to remember to put the block of code around the exact portion of code that should be mutually exclusive
 * you need to have a ready to go RAII lock or a way to emulate it (e.g. `lock` and `unlock`)
-* the syntax is quite ugly
+* the syntax is quite ugly (blocks everywhere)
 
 
 

README.md

@@ -1,4 +1,8 @@
 # Support Class Library
+***<u>WARNING:</u> This is currently a Work In Progress***
+
+
+
 The SCL is a set of tools providing classes and utility functions that aim to ease the development of your applications.
 
 
@@ -31,6 +35,7 @@ Here is the namespace hierarchy:
     * [operators](./include/scl/stream/operators/operators.hpp) - Grouping intermediate stream operation functions
     * [terminators](./include/scl/stream/terminators/terminators.hpp) - Grouping end of stream operation functions 
   * [async](./async/async.hpp) - The asynchronous programming API
+  * [http]( ./http/http.hpp ) - The HTTP API
 
 
 
@@ -42,6 +47,7 @@ Here are some [macros](./include/scl/macros.h) and their meaning:
   * `assert_concept` - Compile time assertions of concepts outside of a block of code (must be simple concepts, not aggregates (e.g. `Copyable ` vs `Invocable`))
   * `static_require` - Require concepts without giving an additional error message
   * `META` - The fully qualified namespace path to the `meta` namespace (actually is `scl::tools::meta`)
+  * `asString` - The function that converts a variable to `std::string` using its `ToString` specialization
 * Flags
   * `SCL_CPP14` - Define this flag to use the C++14 add-ons (e.g. `is_final_t`)
   * `SCL_CPP17` - Define this flag to use the C++17 add-ons (e.g. `is_swappable_t`)

doc/html/_doxymain_8md_source.html

@@ -207,11 +207,10 @@
 <tr id="row_0_6_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_none.html" target="_self">None</a></td><td class="desc">An empty class serving as the type of an empty Optional&lt;T&gt; </td></tr>
 <tr id="row_0_6_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classscl_1_1utils_1_1_optional.html" target="_self">Optional</a></td><td class="desc">A class that allows the use of optional types (might be there) </td></tr>
 <tr id="row_0_6_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_placeholder.html" target="_self">Placeholder</a></td><td class="desc">Class representing parameter/return argument placholders </td></tr>
-<tr id="row_0_6_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_6_7_" class="arrow" onclick="toggleFolder('0_6_7_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classscl_1_1utils_1_1_raw_storage.html" target="_self">RawStorage</a></td><td class="desc">Class that handles raw storage (and manual memory management) for a variable type </td></tr>
-<tr id="row_0_6_7_0_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionscl_1_1utils_1_1_raw_storage_1_1storage__type.html" target="_self">storage_type</a></td><td class="desc">Union that stores the data type uninitialized </td></tr>
+<tr id="row_0_6_7_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classscl_1_1utils_1_1_raw_storage.html" target="_self">RawStorage</a></td><td class="desc">Class that handles raw storage (and manual memory management) for a variable type </td></tr>
 <tr id="row_0_6_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string.html" target="_self">ToString</a></td><td class="desc"></td></tr>
 <tr id="row_0_6_9_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string_3_01_none_01_4.html" target="_self">ToString&lt; None &gt;</a></td><td class="desc">A specialization of <a class="el" href="structscl_1_1utils_1_1_to_string.html">ToString</a> for <a class="el" href="structscl_1_1utils_1_1_none.html" title="An empty class serving as the type of an empty Optional&lt;T&gt; ">None</a> type </td></tr>
-<tr id="row_0_6_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string_3_01scl_1_1http_1_1_status_code_00_01void_01_4.html" target="_self">ToString&lt; scl::http::StatusCode, void &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_0_6_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string_3_01scl_1_1http_1_1_status_code_01_4.html" target="_self">ToString&lt; scl::http::StatusCode &gt;</a></td><td class="desc"></td></tr>
 <tr id="row_0_6_11_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string_3_01scl_1_1http_1_1_version_00_01void_01_4.html" target="_self">ToString&lt; scl::http::Version, void &gt;</a></td><td class="desc"></td></tr>
 <tr id="row_0_6_12_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string_3_01_t_00_01scl_1_1tools_1_1meta_01_1_1enable__if__t_3_01scl_1_ab318f07506cea75df6fc972952f6e8a.html" target="_self">ToString&lt; T, scl::tools::meta ::enable_if_t&lt; scl::tools::meta ::is_base_of&lt; scl::exceptions::Throwable, T &gt;() &gt; &gt;</a></td><td class="desc">Specialization of <a class="el" href="structscl_1_1utils_1_1_to_string.html">ToString</a> for Throwable types </td></tr>
 <tr id="row_0_6_13_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscl_1_1utils_1_1_to_string_3_01_t_00_01scl_1_1tools_1_1meta_01_1_1void__t_3_01scl_1_1tools514ea4627300a8dd6ff0eeaaa38c785b.html" target="_self">ToString&lt; T, scl::tools::meta ::void_t&lt; scl::tools::meta ::enable_if_t&lt; scl::tools::meta ::is_same&lt; T, char &gt;()||scl::tools::meta ::is_same&lt; T, const char * &gt;()||scl::tools::meta ::is_same&lt; T, std::string &gt;() &gt; &gt; &gt;</a></td><td class="desc">Specialization for types convertible to string </td></tr>