userver: userver/storages/redis/parse_reply.hpp Source File
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
parse_reply.hpp
Go to the documentation of this file.
1#pragma once
2
3/// @file
4/// @brief Customizations for Redis response parsings
5
6#include <optional>
7#include <string>
8#include <unordered_map>
9#include <unordered_set>
10#include <vector>
11
12#include <userver/storages/redis/fwd.hpp>
13#include <userver/utils/void_t.hpp>
14
15#include <userver/storages/redis/reply_types.hpp>
16
17USERVER_NAMESPACE_BEGIN
18
19namespace storages::redis {
20namespace impl {
21
22ReplyData&& ExtractData(ReplyPtr& reply);
23
24template <typename Result, typename ReplyType, typename = utils::void_t<>>
25struct HasParseFunctionFromRedisReply {
26 static constexpr bool value = false;
27};
28
29template <typename Result, typename ReplyType>
30struct HasParseFunctionFromRedisReply<
31 Result,
32 ReplyType,
33 utils::void_t<decltype(Result::Parse(std::declval<ReplyData>(), std::declval<const std::string&>()))>> {
34 static constexpr bool value = std::is_same<
35 decltype(Result::Parse(std::declval<ReplyData>(), std::declval<const std::string&>())),
36 ReplyType>::value;
37};
38
39bool IsNil(const ReplyData& reply_data);
40
41void ExpectIsOk(const ReplyPtr& reply, const std::string& request_description);
42
43void ExpectArray(const ReplyData& reply_data, const std::string& request_description);
44
45const std::string& RequestDescription(const ReplyPtr& reply, const std::string& request_description);
46
47} // namespace impl
48
49/// An ADL helper that allows searching for `Parse` functions in namespace
50/// `storages::redis` additionally to the namespace of `Result`.
51template <typename Result, typename ReplyType = Result>
52struct To {};
53
54std::vector<std::string>
55ParseReplyDataArray(ReplyData&& array_data, const std::string& request_description, To<std::vector<std::string>>);
56
57std::vector<std::optional<std::string>>
58ParseReplyDataArray(ReplyData&& array_data, const std::string& request_description, To<std::vector<std::optional<std::string>>>);
59
60std::vector<std::pair<std::string, std::string>>
61ParseReplyDataArray(ReplyData&& array_data, const std::string& request_description, To<std::vector<std::pair<std::string, std::string>>>);
62
63std::vector<MemberScore>
64ParseReplyDataArray(ReplyData&& array_data, const std::string& request_description, To<std::vector<MemberScore>>);
65
66std::vector<GeoPoint>
67ParseReplyDataArray(ReplyData&& array_data, const std::string& request_description, To<std::vector<GeoPoint>>);
68
69std::string Parse(ReplyData&& reply_data, const std::string& request_description, To<std::string>);
70
71double Parse(ReplyData&& reply_data, const std::string& request_description, To<double>);
72
73size_t Parse(ReplyData&& reply_data, const std::string& request_description, To<size_t>);
74
75bool Parse(ReplyData&& reply_data, const std::string& request_description, To<size_t, bool>);
76
77int64_t Parse(ReplyData&& reply_data, const std::string& request_description, To<int64_t>);
78
79std::chrono::system_clock::time_point
80Parse(ReplyData&& reply_data, const std::string& request_description, To<std::chrono::system_clock::time_point>);
81
82HsetReply Parse(ReplyData&& reply_data, const std::string& request_description, To<HsetReply>);
83
84PersistReply Parse(ReplyData&& reply_data, const std::string& request_description, To<PersistReply>);
85
86KeyType Parse(ReplyData&& reply_data, const std::string& request_description, To<KeyType>);
87
88void Parse(ReplyData&& reply_data, const std::string& request_description, To<StatusOk, void>);
89
90bool Parse(ReplyData&& reply_data, const std::string& request_description, To<std::optional<StatusOk>, bool>);
91
92void Parse(ReplyData&& reply_data, const std::string& request_description, To<StatusPong, void>);
93
94SetReply Parse(ReplyData&& reply_data, const std::string& request_description, To<SetReply>);
95
96std::unordered_set<std::string>
97Parse(ReplyData&& reply_data, const std::string& request_description, To<std::unordered_set<std::string>>);
98
99std::unordered_map<std::string, std::string>
100Parse(ReplyData&& reply_data, const std::string& request_description, To<std::unordered_map<std::string, std::string>>);
101
102ReplyData Parse(ReplyData&& reply_data, const std::string& request_description, To<ReplyData>);
103
104template <typename Result, typename ReplyType = Result>
105std::enable_if_t<impl::HasParseFunctionFromRedisReply<Result, ReplyType>::value, ReplyType>
106Parse(ReplyData&& reply_data, const std::string& request_description, To<Result, ReplyType>) {
107 return Result::Parse(std::move(reply_data), request_description);
108}
109
110template <typename T>
111std::vector<T> Parse(ReplyData&& reply_data, const std::string& request_description, To<std::vector<T>>) {
112 impl::ExpectArray(reply_data, request_description);
113 return ParseReplyDataArray(std::move(reply_data), request_description, To<std::vector<T>>{});
114}
115
116template <typename T>
117std::optional<T> Parse(ReplyData&& reply_data, const std::string& request_description, To<std::optional<T>>) {
118 if (impl::IsNil(reply_data)) return std::nullopt;
119 return Parse(std::move(reply_data), request_description, To<T>{});
120}
121
122namespace impl {
123
124template <typename Result, typename ReplyType = Result>
125ReplyType ParseReply(ReplyPtr reply, const std::string& request_description = {}) {
126 const auto& description = impl::RequestDescription(reply, request_description);
127 impl::ExpectIsOk(reply, description);
128 return Parse(impl::ExtractData(reply), description, To<Result, ReplyType>{}); // Customization point
129}
130
131} // namespace impl
132
133} // namespace storages::redis
134
135USERVER_NAMESPACE_END