summaryrefslogtreecommitdiff
path: root/docs/data/core/maybe.json
blob: 82ff6a0e9131631bd92676c74a451ec439379118 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
	"format": 1,
	"id": "saw-maybe",
	"kind": "alias",
	"name": "maybe",
	"namespace": "saw",
	"module": "core",
	"header": "modules/core/c++/common.hpp",
	"type": ["std::optional< T >"],
	"brief_description": "A value which may be absent, without that absence being a failure.",
	"detailed_description": [
		[
			"Distinct from",
			{"name": "error_or", "id": "saw-error_or"},
			"which says something went wrong. A maybe says a value is legitimately not there, as with an optional response slot where the caller may or may not have picked one."
		]
	],
	"templates": [
		{"name": "T", "kind": "type"}
	]
}