Qore MapperUtil Module Reference 1.0.1
Loading...
Searching...
No Matches
MapperUtil.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* Mapper.qm Copyright 2014 - 2024 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
25// minimum required Qore version
26
27// require type definitions everywhere
28
29// enable all warnings
30
31// do not use "$" for vars
32
33
56namespace Mapper {
58 const MapperKeyInfo = ...;
59
60
62 public hashdecl MapperRuntimeKeyInfo {
64 string desc;
65
67 string value_type = "string";
68
70 *hash<string, bool> conflicting_keys;
71
73 bool requires_field_type = False;
74
76
79 *softlist<string> unique_roles;
80
82 *softlist<string> requires_roles;
83
85 *string returns_type;
86
88
111 *code handler;
112 };
113};
All the definitions in the MapperUtil module are contained in the Mapper namespace.
Definition MapperUtil.qm.dox.h:56
const MapperKeyInfo
Mapper standard field key info hash.
Definition MapperUtil.qm.dox.h:58
Describes a runtime mapper field key.
Definition MapperUtil.qm.dox.h:62
*string returns_type
If the key provides a value that returns a specific type.
Definition MapperUtil.qm.dox.h:85
*hash< string, bool > conflicting_keys
Hash of conflicting keys, if any.
Definition MapperUtil.qm.dox.h:70
*softlist< string > requires_roles
If the key can only be used if one or more other keys supplying the given roles are also present.
Definition MapperUtil.qm.dox.h:82
bool requires_field_type
If the type of the value for the key must be the same as the field type.
Definition MapperUtil.qm.dox.h:73
*softlist< string > unique_roles
If the key provides some unique functionality.
Definition MapperUtil.qm.dox.h:79
*code handler
The code to handle the key at runtime.
Definition MapperUtil.qm.dox.h:111
string value_type
The type of value that must be assigned to this key.
Definition MapperUtil.qm.dox.h:67
string desc
A description of the key.
Definition MapperUtil.qm.dox.h:64