userver: userver/storages/redis/parse_reply.hpp Source File
Loading...
Searching...
No Matches
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::vector<std::optional<Point>>
70ParseReplyDataArray(ReplyData&& array_data, const std::string& request_description, To<std::vector<std::optional<Point>>>);
71
72std::string Parse(ReplyData&& reply_data, const std::string& request_description, To<std::string>);
73
74double Parse(ReplyData&& reply_data, const std::string& request_description, To<double>);
75
76size_t Parse(ReplyData&& reply_data, const std::string& request_description, To<size_t>);
77
78bool Parse(ReplyData&& reply_data, const std::string& request_description, To<size_t, bool>);
79
80int64_t Parse(ReplyData&& reply_data, const std::string& request_description, To<int64_t>);
81
82std::chrono::system_clock::time_point
83Parse(ReplyData&& reply_data, const std::string& request_description, To<std::chrono::system_clock::time_point>);
84
85HsetReply Parse(ReplyData&& reply_data, const std::string& request_description, To<HsetReply>);
86
87PersistReply Parse(ReplyData&& reply_data, const std::string& request_description, To<PersistReply>);
88
89KeyType Parse(ReplyData&& reply_data, const std::string& request_description, To<KeyType>);
90
91void Parse(ReplyData&& reply_data, const std::string& request_description, To<StatusOk, void>);
92
93bool Parse(ReplyData&& reply_data, const std::string& request_description, To<std::optional<StatusOk>, bool>);
94
95void Parse(ReplyData&& reply_data, const std::string& request_description, To<StatusPong, void>);
96
97Point Parse(ReplyData&& reply_data, const std::string& request_description, To<Point>);
98
99SetReply Parse(ReplyData&& reply_data, const std::string& request_description, To<SetReply>);
100
101std::unordered_set<std::string>
102Parse(ReplyData&& reply_data, const std::string& request_description, To<std::unordered_set<std::string>>);
103
104std::unordered_map<std::string, std::string>
105Parse(ReplyData&& reply_data, const std::string& request_description, To<std::unordered_map<std::string, std::string>>);
106
107ReplyData Parse(ReplyData&& reply_data, const std::string& request_description, To<ReplyData>);
108
109template <typename Result, typename ReplyType = Result>
110std::enable_if_t<impl::HasParseFunctionFromRedisReply<Result, ReplyType>::value, ReplyType>
111Parse(ReplyData&& reply_data, const std::string& request_description, To<Result, ReplyType>) {
112 return Result::Parse(std::move(reply_data), request_description);
113}
114
115template <typename T>
116std::vector<T> Parse(ReplyData&& reply_data, const std::string& request_description, To<std::vector<T>>) {
117 impl::ExpectArray(reply_data, request_description);
118 return ParseReplyDataArray(std::move(reply_data), request_description, To<std::vector<T>>{});
119}
120
121template <typename T>
122std::optional<T> Parse(ReplyData&& reply_data, const std::string& request_description, To<std::optional<T>>) {
123 if (impl::IsNil(reply_data)) return std::nullopt;
124 return Parse(std::move(reply_data), request_description, To<T>{});
125}
126
127namespace impl {
128
129template <typename Result, typename ReplyType = Result>
130ReplyType ParseReply(ReplyPtr reply, const std::string& request_description = {}) {
131 const auto& description = impl::RequestDescription(reply, request_description);
132 impl::ExpectIsOk(reply, description);
133 return Parse(impl::ExtractData(reply), description, To<Result, ReplyType>{}); // Customization point
134}
135
136} // namespace impl
137
138} // namespace storages::redis
139
140USERVER_NAMESPACE_END