summaryrefslogtreecommitdiff
path: root/docs/data/core/heap.json
blob: 6500895945317a33cd146b9da3a8e303eb80f4df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
	"format": 1,
	"id": "saw-heap",
	"kind": "function",
	"name": "heap",
	"namespace": "saw",
	"module": "core",
	"header": "modules/core/c++/common.hpp",
	"type": [{"name": "own", "id": "saw-own"}, "< T >"],
	"brief_description": "Constructs an object on the heap and hands back sole ownership.",
	"detailed_description": [
		[
			"The one place new is called. Arguments are forwarded to the constructor, so a type which forbids copying and moving can still be built here, which is exactly what the registered servers rely on."
		]
	],
	"templates": [
		{"name": "T", "kind": "type"},
		{"name": "Args", "kind": "type", "pack": true}
	],
	"parameters": [
		{"name": "args", "type": ["Args &&..."], "brief_description": "Forwarded to the constructor of T."}
	]
}