aws-crt-cpp
C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
Public Member Functions | Public Attributes | List of all members
Aws::Crt::S3::S3MetaRequestResult Struct Reference

#include <S3.h>

Public Member Functions

bool IsSuccess () const noexcept
 

Public Attributes

int errorCode
 
int responseStatus
 
Vector< Http::HttpHeader > errorResponseHeaders
 
ByteCursor errorResponseBody
 
bool didValidateChecksum
 
S3ChecksumAlgorithm validationAlgorithm
 

Detailed Description

Result delivered to FinishCallback when a meta request terminates. Mirrors aws_s3_meta_request_result. errorResponseHeaders is a deep copy you may retain freely. errorResponseBody is a borrowed view into CRT-owned memory, valid only for the duration of the FinishCallback invocation; copy out its contents if you need to retain them.

Member Function Documentation

bool Aws::Crt::S3::S3MetaRequestResult::IsSuccess ( ) const
noexcept

True when the meta request completed without error.

Member Data Documentation

bool Aws::Crt::S3::S3MetaRequestResult::didValidateChecksum

True if the server-side checksum was validated against a calculated value.

int Aws::Crt::S3::S3MetaRequestResult::errorCode

AWS_ERROR_SUCCESS on success, a CRT error code otherwise.

ByteCursor Aws::Crt::S3::S3MetaRequestResult::errorResponseBody

Bytes of the S3 error response body, or an empty cursor if not applicable. Borrowed: the underlying buffer is owned by the meta request and freed when the FinishCallback returns, so copy the bytes out if you need to retain them.

Vector<Http::HttpHeader> Aws::Crt::S3::S3MetaRequestResult::errorResponseHeaders

Headers of the S3 error response. Empty if not applicable.

int Aws::Crt::S3::S3MetaRequestResult::responseStatus

HTTP status of the request (the successful response on success, or the failed request on an S3 error response); 0 for other error codes.

S3ChecksumAlgorithm Aws::Crt::S3::S3MetaRequestResult::validationAlgorithm

Algorithm used for checksum validation, when didValidateChecksum is true.


The documentation for this struct was generated from the following files: