[#boost-urls-grammar-parse]
= 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#L37[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;
xref:boost/urls/grammar/parse-06.adoc[parse](
    char const*& it,
    char const* end,
    R const& r);
----

[.small]#xref:boost/urls/grammar/parse-06.adoc[_» more..._]#

[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;
xref:boost/urls/grammar/parse-02.adoc[parse](
    core::string&lowbar;view s,
    R const& r);
----

[.small]#xref:boost/urls/grammar/parse-02.adoc[_» more..._]#

== Return Value


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



== Parameters


|===
| Name | Description

| *it*
| A pointer to the start&period; The    caller&apos;s variable is changed to    reflect the amount of input consumed&period;


| *end*
| A pointer to the end&period;


| *r*
| The rule to use


| *s*
| The input string


|===



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