AWS SDK for C++

AWS SDK for C++ Version 1.11.929

Loading...
Searching...
No Matches
Codec.h
1#pragma once
2
3#include <aws/core/client/AWSError.h>
4#include <aws/core/client/CoreErrors.h>
5#include <aws/core/utils/Outcome.h>
6#include <aws/core/utils/memory/AWSMemory.h>
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/crt/Types.h>
9#include <smithy/Smithy_EXPORTS.h>
10#include <smithy/client/schema/SerdeTraits.h>
11#include <smithy/client/schema/SerializableStruct.h>
12#include <smithy/client/schema/ShapeDeserializer.h>
13
14namespace smithy {
15namespace schema {
16
17class Schema;
18
19// Per-protocol timestamp default threaded to a codec's serializer and deserializer. The format is the
20// fallback used when a member carries no @timestampFormat trait.
21class CodecSettings final {
22 public:
23 explicit CodecSettings(TimestampFormatTrait::Format defaultTimestampFormat) : m_defaultTimestampFormat(defaultTimestampFormat) {}
24
25 // Default payload timestamp format for each protocol.
29
30 TimestampFormatTrait::Format GetDefaultTimestampFormat() const { return m_defaultTimestampFormat; }
31
32 private:
33 TimestampFormatTrait::Format m_defaultTimestampFormat;
34};
35
36class SMITHY_API Codec {
37 public:
39
40 virtual ~Codec() = default;
41
42 virtual SerializerOutcome Serialize(const Schema& schema, const SerializableStruct& shape) const = 0;
43
44 virtual Aws::UniquePtr<ShapeDeserializer> CreateDeserializer(Aws::Crt::ByteCursor data) const = 0;
45
46 void DeserializeShape(Aws::Crt::ByteCursor data, SerializableStruct& shape) const {
47 shape.Deserialize(*CreateDeserializer(data));
48 }
49};
50
51class SMITHY_API JsonCodec final : public Codec {
52 public:
53 explicit JsonCodec(CodecSettings settings = CodecSettings::Json()) : m_settings(settings) {}
54 SerializerOutcome Serialize(const Schema& schema, const SerializableStruct& shape) const override;
55 Aws::UniquePtr<ShapeDeserializer> CreateDeserializer(Aws::Crt::ByteCursor data) const override;
56
57 private:
58 CodecSettings m_settings;
59};
60
61class SMITHY_API XmlCodec final : public Codec {
62 public:
63 explicit XmlCodec(CodecSettings settings = CodecSettings::Xml()) : m_settings(settings) {}
64 SerializerOutcome Serialize(const Schema& schema, const SerializableStruct& shape) const override;
65 Aws::UniquePtr<ShapeDeserializer> CreateDeserializer(Aws::Crt::ByteCursor data) const override;
66
67 private:
68 CodecSettings m_settings;
69};
70
71class SMITHY_API CborCodec final : public Codec {
72 public:
73 SerializerOutcome Serialize(const Schema& schema, const SerializableStruct& shape) const override;
74 Aws::UniquePtr<ShapeDeserializer> CreateDeserializer(Aws::Crt::ByteCursor data) const override;
75};
76
77} // namespace schema
78} // namespace smithy
SerializerOutcome Serialize(const Schema &schema, const SerializableStruct &shape) const override
Aws::UniquePtr< ShapeDeserializer > CreateDeserializer(Aws::Crt::ByteCursor data) const override
virtual ~Codec()=default
virtual SerializerOutcome Serialize(const Schema &schema, const SerializableStruct &shape) const =0
void DeserializeShape(Aws::Crt::ByteCursor data, SerializableStruct &shape) const
Definition Codec.h:46
virtual Aws::UniquePtr< ShapeDeserializer > CreateDeserializer(Aws::Crt::ByteCursor data) const =0
static CodecSettings Json()
Definition Codec.h:26
static CodecSettings Xml()
Definition Codec.h:27
CodecSettings(TimestampFormatTrait::Format defaultTimestampFormat)
Definition Codec.h:23
TimestampFormatTrait::Format GetDefaultTimestampFormat() const
Definition Codec.h:30
static CodecSettings Query()
Definition Codec.h:28
Aws::UniquePtr< ShapeDeserializer > CreateDeserializer(Aws::Crt::ByteCursor data) const override
JsonCodec(CodecSettings settings=CodecSettings::Json())
Definition Codec.h:53
SerializerOutcome Serialize(const Schema &schema, const SerializableStruct &shape) const override
void Deserialize(ShapeDeserializer &deserializer)
SerializerOutcome Serialize(const Schema &schema, const SerializableStruct &shape) const override
XmlCodec(CodecSettings settings=CodecSettings::Xml())
Definition Codec.h:63
Aws::UniquePtr< ShapeDeserializer > CreateDeserializer(Aws::Crt::ByteCursor data) const override
std::unique_ptr< T, D > UniquePtr
Definition AWSMemory.h:255