Struct query_arg

Boost C++ Libraries

Struct query_arg

boost::taar::handler::query_arg — Argument provider that reads a URL query parameter.

Synopsis

// In header: <boost/taar/handler/rest_arg.hpp>


struct query_arg {

  // public member functions
  query_arg(std::string, boost::urls::ignore_case_param = {});
  query_arg(std::string, std::string, boost::urls::ignore_case_param = {});
  std::string const & name() const;
  std::string const & description() const;
  taar::result< std::string > 
  operator()(boost::beast::http::request_header<> const &, 
             matcher::context const &) const;

  // public data members
  std::string query_key_;
  boost::urls::ignore_case_param ic_;
  std::string description_;
};

Description

Parses the request target as an origin-form URL and looks up query_key in the query string. The second parameter controls case-sensitivity: pass boost::urls::ignore_case to match case-insensitively.

Reports error::argument_not_found if the parameter is absent and error::argument_ambiguous if it appears more than once.

`query_arg` public member functions

query_arg(std::string query_key, boost::urls::ignore_case_param ic = {});

query_arg(std::string query_key, std::string description, 
          boost::urls::ignore_case_param ic = {});

```
std::string const & name() const;
```

std::string const & description() const;

taar::result< std::string > 
operator()(boost::beast::http::request_header<> const & request, 
           matcher::context const &) const;