blob: b35691b2c47eae2bdb1eff64e575aadbea5b9192 (
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Sample idl
# Demonstrates a subset of features
# 1. string types
# 2. int types
# 3. a custom type, NamespaceString
# 4. Nested structs
# 5. Optional fields
# 6. Default values
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/db/namespace_string.h"
types:
string:
bson_serialization_type: string
description: "A BSON UTF-8 string"
cpp_type: "std::string"
deserializer: "mongo::BSONElement::str"
int:
bson_serialization_type: int
description: "A BSON 32-bit integer"
cpp_type: "std::int32_t"
deserializer: "mongo::BSONElement::_numberInt"
namespacestring:
bson_serialization_type: string
description: "A MongoDB NamespaceString"
cpp_type: "mongo::NamespaceString"
serializer: mongo::NamespaceString::toString
deserializer: mongo::NamespaceString
safeInt32:
description: Accepts any numerical type within int32 range
cpp_type: std::int64_t
bson_serialization_type:
- long
- int
- decimal
- double
deserializer: "mongo::BSONElement::numberInt"
bindata_generic:
bson_serialization_type: bindata
bindata_subtype: generic
description: "A BSON bindata of "
cpp_type: "std::vector<std::uint8_t>"
deserializer: "mongo::BSONElement::_binDataVector"
bindata_uuid:
bson_serialization_type: bindata
bindata_subtype: uuid
description: "A BSON bindata of uuid sub type"
cpp_type: "std::array<std::uint8_t, 16>"
deserializer: "mongo::BSONElement::uuid"
structs:
default_values:
description: UnitTest for a single safeInt32
fields:
stringfield:
type: string
default: '"a default"'
description: "An example string field with default value"
intfield:
type: int
default: 42
description: "An example int field with default value"
numericfield:
type: safeInt32
description: "A numeric type that supports multiple types"
nsfield:
type: namespacestring
description: "A namespace string type"
optionalField:
type: string
optional: true
description: "An optional string"
vectorField:
type: array<int>
description: "An example int array field with default value"
binDataField:
type: bindata_generic
description: "A binData of generic subtype"
uuidField:
type: bindata_uuid
description: "A binData of uuid subtype"
|
