Function template parse

boost::parser::parse

Synopsis

// In header: <boost/parser/parser.hpp>


template<parsable_range R, typename Parser, typename GlobalState, 
         typename ErrorHandler> 
  auto parse(R const & r, 
             parser_interface< Parser, GlobalState, ErrorHandler > const & parser, 
             trace trace_mode = trace::off);

Description

Parses r using parser. Returns a std::optional containing the attribute produced by parser on parse success, and std::nullopt on parse failure. The entire input range r must be consumed for the parse to be considered successful. If trace_mode == trace::on, a verbose trace of the parse will be streamed to std::cout.

Template Parameters:

ErrorHandler

Constrained by error_handler<ErrorHandler,std::ranges::iterator_t<decltype(subrange_of(r))>, std::ranges::sentinel_t<decltype(subrange_of(r))>, GlobalState>, where subrange_of is an implementation detail that: creates subranges out of pointers; trims trailing zeros off of bounded arrays (such as string literals); and transcodes to UTF-32 if the input is non-char.

Boost C++ Libraries