[#boost-urls-grammar-parse-02]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/grammar.adoc[grammar]::parse
:relfileprefix: ../../../
:mrdocs:

Parse a character buffer using a rule

== Synopsis

Declared in `&lt;https://www.github.com/boostorg/url/blob/develop/include/boost/url/grammar/parse.hpp#L58[boost&sol;url&sol;grammar&sol;parse&period;hpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;xref:boost/urls/grammar/Rule.adoc[Rule] R&gt;
system::result&lt;R::value&lowbar;type&gt;
parse(
    core::string&lowbar;view s,
    R const& r);
----

== Description

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

== Return Value

The parsed value upon success, otherwise an error&period;

== Parameters

[cols="1,4"]
|===
|Name|Description

| *s*
| The input string
| *r*
| The rule to use
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
