QRestReply Class

Documentation sur les fonctions membres

[explicit] QRestReply::QRestReply(QNetworkReply *reply)

Crée un objet `QRestReply` et initialise l'objet encapsulé ` QNetworkReply ` à la valeur ` reply`.

[noexcept] QRestReply::QRestReply(QRestReply &&other)

Construit la réponse à partir de other.

[noexcept] QRestReply::~QRestReply()

Supprime cet objet « QRestReply ».

QNetworkReply::NetworkError QRestReply::error() const

Renvoie la dernière erreur, le cas échéant. Les erreurs incluent notamment les erreurs de réseau et de protocole, mais excluent les cas où le serveur a répondu avec succès en renvoyant un statut HTTP.

Voir également httpStatus(), isSuccess(), hasError() et errorString().

QString QRestReply::errorString() const

Renvoie une description lisible par l'utilisateur de la dernière erreur réseau.

Voir également httpStatus(), isSuccess(), hasError() et error().

bool QRestReply::hasError() const

Indique si une erreur s'est produite. Cela inclut les erreurs telles que les erreurs de réseau et de protocole, mais exclut les cas où le serveur a répondu avec succès en renvoyant un code d'erreur HTTP (par exemple 500 Internal Server Error). Utilisez httpStatus() ou isHttpStatusSuccess() pour obtenir les informations relatives au statut HTTP.

Voir également httpStatus(), isSuccess(), error() et errorString().

int QRestReply::httpStatus() const

Renvoie le statut HTTP reçu dans la réponse du serveur. La valeur est 0 s'il n'est pas disponible (la ligne de statut n'a pas encore été reçue).

Voir également isSuccess(), hasError() et error().

bool QRestReply::isHttpStatusSuccess() const

Indique si le code d'état HTTP est compris entre 200 et 299.

Voir également isSuccess(), httpStatus(), hasError() et error().

bool QRestReply::isSuccess() const

Indique si le code d'état HTTP est compris entre 200 et 299 et si aucune autre erreur ne s'est produite lors de la réception de la réponse (par exemple, une déconnexion soudaine pendant la réception du corps de la réponse). Cette fonction constitue un moyen pratique de vérifier si la réponse est considérée comme réussie.

Voir également httpStatus(), hasError() et error().

QNetworkReply *QRestReply::networkReply() const

Renvoie un pointeur vers l'QNetworkReply e sous-jacente encapsulée par cet objet.

QByteArray QRestReply::readBody()

Renvoie les données reçues sous la forme d'un objet ` QByteArray`.

L'appel de cette fonction consomme les données reçues jusqu'à présent, et tout appel ultérieur visant à obtenir des données de réponse renverra une valeur vide jusqu'à ce que de nouvelles données aient été reçues.

Voir également readJson(), readText(), QNetworkReply::bytesAvailable() et QNetworkReply::readyRead().

std::optional<QJsonDocument> QRestReply::readJson(QJsonParseError *error = nullptr)

Renvoie les données reçues sous la forme d'un objet ` QJsonDocument`.

La valeur renvoyée est encapsulée dans un objet ` std::optional`. Si la conversion à partir des données reçues échoue (données vides ou erreur d’analyse JSON), la valeur ` std::nullopt ` est renvoyée, et l’objet ` error ` est renseigné avec les détails.

L’appel de cette fonction consomme les données reçues, et tout appel ultérieur visant à obtenir des données de réponse renverra une valeur vide.

Cette fonction renvoie ` std::nullopt ` et ne consomme aucune donnée si la réponse n’est pas terminée. Si ` error ` est passé en paramètre, il sera défini sur ` QJsonParseError::NoError ` afin de distinguer ce cas d’une erreur réelle.

Voir également readBody() et readText().

QString QRestReply::readText()

Renvoie les données reçues au format « QString ».

Les données reçues sont décodées en un objet ` QString ` (UTF-16). Si l’information est disponible, le décodage utilise le paramètre `charset` de l’en-tête `Content-Type` pour déterminer l’encodage source. Si l’information d’encodage n’est pas disponible ou n’est pas prise en charge par ` QStringConverter`, l’encodage UTF-8 est utilisé par défaut.

L'appel de cette fonction consomme les données reçues jusqu'à présent. Elle renvoie une valeur construite par défaut si aucune nouvelle donnée n'est disponible, si le décodage n'est pas pris en charge par QStringConverter ou si le décodage contient des erreurs (par exemple, des caractères non valides).

Voir également readJson(), readBody() et QNetworkReply::readyRead().

[noexcept] QRestReply &QRestReply::operator=(QRestReply &&other)

La fonction « move-assigns » other et renvoie une référence à cette réponse.