[#BCLog-LogRateLimiter-Consume]
= xref:BCLog.adoc[BCLog]::xref:BCLog/LogRateLimiter.adoc[LogRateLimiter]::Consume
:relfileprefix: ../../
:mrdocs:

Consumes `source&lowbar;loc`&apos;s available bytes corresponding to the size of the (formatted) `str` and returns its status&period;

== Synopsis

Declared in `&lt;logging&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lsqb;&lsqb;nodiscard, requires&lowbar;capability(0x7f95152a3af8)&rsqb;&rsqb;
xref:BCLog/LogRateLimiter/Status.adoc[Status]
Consume(
    xref:SourceLocation.adoc[SourceLocation] const& source&lowbar;loc,
    std::string const& str);
----

== Return Value

The suppression status for this location after consuming the string&period;

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *source&lowbar;loc*
| The source location the log entry originates from&period;
| *str*
| The formatted log string whose size is charged against the location&apos;s budget&period;
|===


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