1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 3<title>Tutorial - Boost.Outcome documentation</title> 4<link rel="stylesheet" href="./css/boost.css" type="text/css"> 5<meta name="generator" content="Hugo 0.52 with Boostdoc theme"> 6<meta name="viewport" content="width=device-width,initial-scale=1.0"/> 7 8<link rel="icon" href="./images/favicon.ico" type="image/ico"/> 9<body><div class="spirit-nav"> 10<a accesskey="p" href="./motivation/narrow_contract.html"><img src="./images/prev.png" alt="Prev"></a> 11 <a accesskey="u" href="./index.html"><img src="./images/up.png" alt="Up"></a> 12 <a accesskey="h" href="./index.html"><img src="./images/home.png" alt="Home"></a><a accesskey="n" href="./tutorial/essential.html"><img src="./images/next.png" alt="Next"></a></div><div id="content"> 13 14 <div class="titlepage"><div><div><h1 style="clear: both">Tutorial</h1></div></div></div> 15<ol class="children children-li"><li> 16 <a href="./tutorial/essential.html" >Essential</a> 17<p>The absolute minimum that you need to know to get started with Outcome immediately.</p><ol><li> 18 <a href="./tutorial/essential/before.html" >Before we begin</a> 19<p>Essential information before you begin the tutorial.</p><li> 20 <a href="./tutorial/essential/result.html" >result<></a> 21<p>Gentle introduction to writing code with simple success-or-failure return types.</p><li> 22 <a href="./tutorial/essential/outcome.html" >outcome<></a> 23<p>Success-or-failure return types where failure can take two forms, expected/handled failure and unexpected/abort failure.</p><li> 24 <a href="./tutorial/essential/no-value.html" >No-value policies</a> 25<p>Describes the concept of NoValuePolicy and how to use no-value policies.</p><li> 26 <a href="./tutorial/essential/coroutines.html" >Coroutines</a> 27<p>Using Outcome in C++ Coroutines</p><li> 28 <a href="./tutorial/essential/conventions.html" >Conventions</a> 29<p>Why you should avoid custom <code>E</code> types in public APIs.</p></li></ol><li> 30 <a href="./tutorial/advanced.html" >Advanced</a> 31<p>If you have a bit more time, this covers all the time-saving ways you can customise and automate Outcome for various use cases, especially in larger codebases made up of multiple third party libraries.</p><ol><li> 32 <a href="./tutorial/advanced/payload.html" >Custom payloads</a> 33<p>Success-or-failure return types where extra information in addition to the error code accompanies failure.</p><li> 34 <a href="./tutorial/advanced/constructors.html" >Result returning constructors</a> 35<p>How to metaprogram construction of objects which use result<T, EC> to return failure instead of throwing a C++ exception.</p><li> 36 <a href="./tutorial/advanced/hooks.html" >Hooking events</a> 37<p>Intercepting useful events such as initial construction, copies and moves so you can capture backtraces, fire debug breakpoints etc.</p><li> 38 <a href="./tutorial/advanced/interop.html" >Interoperation</a> 39<p>Interoperating with std::expected<T, E> and other ValueOrError concept matching types.</p></li></ol></li></ol> 40 41 42 43 44 45 46 47 48 </div><p><small>Last revised: October 17, 2017 at 22:41:15 +0100</small></p> 49<hr> 50<div class="spirit-nav"> 51<a accesskey="p" href="./motivation/narrow_contract.html"><img src="./images/prev.png" alt="Prev"></a> 52 <a accesskey="u" href="./index.html"><img src="./images/up.png" alt="Up"></a> 53 <a accesskey="h" href="./index.html"><img src="./images/home.png" alt="Home"></a><a accesskey="n" href="./tutorial/essential.html"><img src="./images/next.png" alt="Next"></a></div></body> 54</html> 55
