summaryrefslogtreecommitdiffstats
path: root/src/grpc/qgrpcstatus.cpp
blob: bd4ab94af809e008134c407eae8b2149ecc31a41 (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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2019 Alexey Edelev <semlanik@gmail.com>
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#include <QtGrpc/qgrpcstatus.h>

#include <QtCore/qdatastream.h>
#include <QtCore/qdebug.h>
#include <QtCore/qvariant.h>

QT_BEGIN_NAMESPACE

/*!
    \class QGrpcStatus
    \inmodule QtGrpc
    \compares equality
    \compareswith equality QtGrpc::StatusCode
    \endcompareswith
    \brief The QGrpcStatus class combines a \l {QtGrpc::} {StatusCode} and a
    string message.

    The QGrpcStatus class usually provides information about a finished \gRPC
    operation, as returned by the server.

    If a RPC operation failed, contains a \l {QtGrpc::} {StatusCode} other than
    \l {QtGrpc::StatusCode::} {Ok}.
*/

/*!
    \property QGrpcStatus::code
    \brief \l {QtGrpc::} {StatusCode} received for prior \gRPC call.
*/

/*!
    \property QGrpcStatus::message
    \brief Status message received for prior \gRPC call.
*/

/*!
    Constructs a QGrpcStatus with the status code \a code and the string \a
    message.
*/
QGrpcStatus::QGrpcStatus(QtGrpc::StatusCode code, QAnyStringView message)
    : m_code(code), m_message(message.toString())
{
}

/*!
    Destroys the QGrpcStatus.
*/
QGrpcStatus::~QGrpcStatus() = default;

/*!
    Copy-constructs a QGrpcStatus from \a other
*/
QGrpcStatus::QGrpcStatus(const QGrpcStatus &other) = default;

/*!
    Assigns the data of the \a other object to this status object and returns
    a reference to it.
*/
QGrpcStatus &QGrpcStatus::operator=(const QGrpcStatus &other) = default;

/*!
    \fn QGrpcStatus::QGrpcStatus(QGrpcStatus &&other) noexcept

    Move-constructs a new QGrpcStatus from \a other.

    \include qtgrpc-shared.qdocinc move-note-desc
*/

/*!
    \fn QGrpcStatus& QGrpcStatus::operator=(QGrpcStatus &&other) noexcept

    Move-assigns \a other to this QGrpcStatus instance and returns a reference
    to it.

    \include qtgrpc-shared.qdocinc move-note-desc
*/

/*!
    \since 6.8

    \include qtgrpc-shared.qdocinc qvariant-desc
*/
QGrpcStatus::operator QVariant() const
{
    return QVariant::fromValue(*this);
}

/*!
    \since 6.8
    \fn void QGrpcStatus::swap(QGrpcStatus &other) noexcept

    \include qtgrpc-shared.qdocinc swap-desc
*/

/*!
    \fn QtGrpc::StatusCode QGrpcStatus::code() const noexcept

    Returns the contained \l {QtGrpc::} {StatusCode}.
*/

/*!
    \fn const QString &QGrpcStatus::message() const & noexcept
    \fn QString QGrpcStatus::message() && noexcept

    Returns the contained status message.
*/

/*!
    \since 6.8
    \fn bool QGrpcStatus::isOk() const noexcept

    Returns \c true if code() is equal to \l {QtGrpc::StatusCode::} {Ok}.
*/

/*!
    \fn bool QGrpcStatus::operator==(const QGrpcStatus &lhs, const QtGrpc::StatusCode &rhs) noexcept

    Returns \c true if the status codes in \a lhs and \a rhs are equal.
*/

/*!
    \fn bool QGrpcStatus::operator!=(const QGrpcStatus &lhs, const QtGrpc::StatusCode &rhs) noexcept

    Returns \c true if the status codes in \a lhs and \a rhs are not equal.
*/

/*!
    \fn bool QGrpcStatus::operator==(const QGrpcStatus &lhs, const QGrpcStatus &rhs) noexcept

    Returns \c true if the status codes in \a lhs and \a rhs are equal.
*/

/*!
    \fn bool QGrpcStatus::operator!=(const QGrpcStatus &lhs, const QGrpcStatus &rhs) noexcept

    Returns \c true if the status codes in \a lhs and \a rhs are not equal.
*/

/*!
    \since 6.8
    \fn size_t QGrpcStatus::qHash(const QGrpcStatus &key, size_t seed) noexcept

    \include qtgrpc-shared.qdocinc qhash-desc
*/

#ifndef QT_NO_DEBUG_STREAM

/*!
    \since 6.8
    \fn QDebug QGrpcStatus::operator<<(QDebug debug, const QGrpcStatus& status)

    Writes \a status to the specified stream \a debug.
*/
QDebug operator<<(QDebug debug, const QGrpcStatus &status)
{
    const QDebugStateSaver save(debug);
    debug.nospace() << "QGrpcStatus( code: " << status.code() << ", message: " << status.message()
                    << " )";
    return debug;
}

#endif // QT_NO_DEBUG_STREAM

#ifndef QT_NO_DATASTREAM

/*!
    \since 6.8
    \fn QDataStream &QGrpcStatus::operator<<(QDataStream &out, const QGrpcStatus &status)

    Writes the given \a status to the specified stream \a out.
*/
QDataStream &operator<<(QDataStream &out, const QGrpcStatus &status)
{
    out << status.m_code << status.m_message;
    return out;
}

/*!
    \since 6.8
    \fn QDataStream &QGrpcStatus::operator>>(QDataStream &in, QGrpcStatus &status)

    Reads a QGrpcStatus from stream \a in into \a status.
*/
QDataStream &operator>>(QDataStream &in, QGrpcStatus &status)
{
    in >> status.m_code;
    in >> status.m_message;
    return in;
}

#endif // QT_NO_DATASTREAM

QT_END_NAMESPACE

#include "moc_qgrpcstatus.cpp"