summaryrefslogtreecommitdiff
path: root/docs/data/core/own.json
blob: 1716ab3c7da66ce08f8b02fcee6ac0e28ef5e9c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
	"format": 1,
	"id": "saw-own",
	"kind": "alias",
	"name": "own",
	"namespace": "saw",
	"module": "core",
	"header": "modules/core/c++/common.hpp",
	"type": ["std::unique_ptr< T >"],
	"brief_description": "Sole ownership of a heap object.",
	"detailed_description": [
		[
			"One of the four ownership words the codebase uses in place of raw pointers: own is sole ownership,",
			{"name": "our", "id": "saw-our"},
			"is shared,",
			{"name": "lent", "id": "saw-lent"},
			"is a weak borrow, and",
			{"name": "ptr", "id": "saw-ptr"},
			"owns nothing at all."
		],
		[
			"Created through",
			{"name": "heap", "id": "saw-heap"},
			"rather than by calling new."
		]
	],
	"templates": [
		{"name": "T", "kind": "type"}
	]
}