[#script-Const]
= xref:script.adoc[script]::Const
:relfileprefix: ../
:mrdocs:

Parse a constant.

== Synopsis

Declared in `<script/parsing.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
Const(
    std::string const& str,
    std::span<char const>& sp,
    bool skip = true);
----

== Description

If sp's initial part matches str, sp is optionally updated to skip that part, and true is returned. Otherwise sp is unmodified and false is returned.

== Return Value

true if sp begins with str, false otherwise.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *str*
| The constant text to match against the start of sp.
| *sp*
| The input span; on a match it is advanced past the constant when skip is true.
| *skip*
| Whether to advance sp past the matched constant.
|===


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