:relfileprefix: ../../../
[#boost-urls-grammar-parse-02]

== xref:boost.adoc[pass:[boost]]::xref:boost/urls.adoc[pass:[urls]]::xref:boost/urls/grammar.adoc[pass:[grammar]]::parse


Parse a character buffer using a rule


=== Synopsis

Declared in header `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/grammar/parse.hpp#L59[boost/url/grammar/parse.hpp,window=blank_]>`

[source,cpp,subs="verbatim,macros,-callouts"]
----
template<class Rule>
system::result<Rule::value_type>
parse(
    core::string_view s,
    Rule const& r);
----

=== Description


This function parses a complete string into
the specified sequence of rules. If the
string is not completely consumed, an
error is returned instead.




=== Return Value


The parsed value upon success,
otherwise an error.



=== Parameters

|===
| Name | Description 

| *s*
| 
The input string

| *r*
| 
The rule to use

|===