boost/redis/ignore.hpp

0001
0002 /* Copyright (c) 2018-2024 Marcelo Zimbres Silva (mzimbres@gmail.com)
0003  *
0004  * Distributed under the Boost Software License, Version 1.0. (See
0005  * accompanying file LICENSE.txt)
0006  */
0007
0008 #ifndef BOOST_REDIS_IGNORE_HPP
0009 #define BOOST_REDIS_IGNORE_HPP
0010
0011 #include <boost/system/result.hpp>
0012
0013 #include <tuple>
0014 #include <type_traits>
0015
0016 namespace boost::redis
0017 {
0018
0019 /** @brief Type used to ignore responses.
0020  *  @ingroup high-level-api
0021  *
0022  *  For example
0023  *
0024  *  @code
0025  *  response<ignore_t, std::string, ignore_t> resp;
0026  *  @endcode
0027  *
0028  *  will ignore the first and third responses. RESP3 errors won't be
0029  *  ignore but will cause `async_exec` to complete with an error.
0030  */
0031 using ignore_t = std::decay_t<decltype(std::ignore)>;
0032
0033 /** @brief Global ignore object.
0034  *  @ingroup high-level-api
0035  *
0036  *  Can be used to ignore responses to a request
0037  *
0038  *  @code
0039  *  conn->async_exec(req, ignore, ...);
0040  *  @endcode
0041  *
0042  *  RESP3 errors won't be ignore but will cause `async_exec` to
0043  *  complete with an error.
0044  */
0045 extern ignore_t ignore;
0046
0047 } // boost::redis
0048
0049 #endif // BOOST_REDIS_IGNORE_HPP