Qpid Proton C++ API  0.32.0
type_id.hpp
Go to the documentation of this file.
1 #ifndef PROTON_TYPE_ID_HPP
2 #define PROTON_TYPE_ID_HPP
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
27 
28 #include "./internal/export.hpp"
29 
30 #include <proton/codec.h>
31 
32 #include <string>
33 
34 namespace proton {
35 
37 enum type_id {
38  NULL_TYPE = PN_NULL,
39  BOOLEAN = PN_BOOL,
40  UBYTE = PN_UBYTE,
41  BYTE = PN_BYTE,
42  USHORT = PN_USHORT,
43  SHORT = PN_SHORT,
44  UINT = PN_UINT,
45  INT = PN_INT,
46  CHAR = PN_CHAR,
47  ULONG = PN_ULONG,
48  LONG = PN_LONG,
49  TIMESTAMP = PN_TIMESTAMP,
50  FLOAT = PN_FLOAT,
51  DOUBLE = PN_DOUBLE,
52  DECIMAL32 = PN_DECIMAL32,
53  DECIMAL64 = PN_DECIMAL64,
54  DECIMAL128 = PN_DECIMAL128,
55  UUID = PN_UUID,
56  BINARY = PN_BINARY,
57  STRING = PN_STRING,
58  SYMBOL = PN_SYMBOL,
59  DESCRIBED = PN_DESCRIBED,
60  ARRAY = PN_ARRAY,
61  LIST = PN_LIST,
62  MAP = PN_MAP
63 };
64 
66 PN_CPP_EXTERN std::string type_name(type_id);
67 
69 PN_CPP_EXTERN std::ostream& operator<<(std::ostream&, type_id);
70 
73 PN_CPP_EXTERN void assert_type_equal(type_id want, type_id got);
74 
77 inline bool type_id_is_signed_int(type_id t) { return t == BYTE || t == SHORT || t == INT || t == LONG; }
78 inline bool type_id_is_unsigned_int(type_id t) { return t == UBYTE || t == USHORT || t == UINT || t == ULONG; }
79 inline bool type_id_is_integral(type_id t) { return t == BOOLEAN || t == CHAR || t == TIMESTAMP || type_id_is_unsigned_int(t) || type_id_is_signed_int(t); }
80 inline bool type_id_is_floating_point(type_id t) { return t == FLOAT || t == DOUBLE; }
81 inline bool type_id_is_decimal(type_id t) { return t == DECIMAL32 || t == DECIMAL64 || t == DECIMAL128; }
82 inline bool type_id_is_signed(type_id t) { return type_id_is_signed_int(t) || type_id_is_floating_point(t) || type_id_is_decimal(t); }
83 inline bool type_id_is_string_like(type_id t) { return t == BINARY || t == STRING || t == SYMBOL; }
84 inline bool type_id_is_container(type_id t) { return t == LIST || t == MAP || t == ARRAY || t == DESCRIBED; }
85 
86 inline bool type_id_is_null(type_id t) { return t == NULL_TYPE; }
87 
88 inline bool type_id_is_scalar(type_id t) {
89  return type_id_is_integral(t) ||
90  type_id_is_floating_point(t) ||
91  type_id_is_decimal(t) ||
92  type_id_is_string_like(t) ||
93  type_id_is_null(t) ||
94  t == TIMESTAMP ||
95  t == UUID;
96 }
97 
99 
100 } // proton
101 
102 #endif // PROTON_TYPE_ID_HPP
proton::TIMESTAMP
@ TIMESTAMP
Signed 64-bit milliseconds since the epoch.
Definition: type_id.hpp:49
proton::UBYTE
@ UBYTE
Unsigned 8-bit integer.
Definition: type_id.hpp:40
proton::DECIMAL128
@ DECIMAL128
128-bit decimal floating point.
Definition: type_id.hpp:54
proton::LIST
@ LIST
A sequence of values of mixed types.
Definition: type_id.hpp:61
proton::BOOLEAN
@ BOOLEAN
Boolean true or false.
Definition: type_id.hpp:39
proton::DESCRIBED
@ DESCRIBED
A descriptor and a value.
Definition: type_id.hpp:59
proton::MAP
@ MAP
A sequence of key-value pairs.
Definition: type_id.hpp:62
proton::INT
@ INT
Signed 32-bit integer.
Definition: type_id.hpp:45
proton::operator<<
std::ostream & operator<<(std::ostream &, const binary &)
Print a binary value.
proton::UINT
@ UINT
Unsigned 32-bit integer.
Definition: type_id.hpp:44
proton::ULONG
@ ULONG
Unsigned 64-bit integer.
Definition: type_id.hpp:47
proton::FLOAT
@ FLOAT
32-bit binary floating point.
Definition: type_id.hpp:50
proton::NULL_TYPE
@ NULL_TYPE
The null type, contains no data.
Definition: type_id.hpp:38
proton::UUID
@ UUID
16-byte UUID.
Definition: type_id.hpp:55
proton::DECIMAL32
@ DECIMAL32
32-bit decimal floating point.
Definition: type_id.hpp:52
proton::USHORT
@ USHORT
Unsigned 16-bit integer.
Definition: type_id.hpp:42
proton::BYTE
@ BYTE
Signed 8-bit integer.
Definition: type_id.hpp:41
proton::type_id
type_id
An identifier for AMQP types.
Definition: type_id.hpp:37
proton::LONG
@ LONG
Signed 64-bit integer.
Definition: type_id.hpp:48
proton::BINARY
@ BINARY
Variable-length sequence of bytes.
Definition: type_id.hpp:56
proton::SHORT
@ SHORT
Signed 16-bit integer.
Definition: type_id.hpp:43
proton::ARRAY
@ ARRAY
A sequence of values of the same type.
Definition: type_id.hpp:60
proton::CHAR
@ CHAR
32-bit unicode character.
Definition: type_id.hpp:46
proton::DOUBLE
@ DOUBLE
64-bit binary floating point.
Definition: type_id.hpp:51
proton
The main Proton namespace.
Definition: annotation_key.hpp:33
proton::type_name
std::string type_name(type_id)
Get the name of the AMQP type.
proton::STRING
@ STRING
Variable-length utf8-encoded string.
Definition: type_id.hpp:57
proton::SYMBOL
@ SYMBOL
Variable-length encoded string.
Definition: type_id.hpp:58
proton::DECIMAL64
@ DECIMAL64
64-bit decimal floating point.
Definition: type_id.hpp:53
proton::assert_type_equal
void assert_type_equal(type_id want, type_id got)
Throw a conversion_error if want != got with a message including the names of the types.