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

Consumes `source_loc`'s available bytes corresponding to the size of the (formatted) `str` and returns its status.

== Synopsis

Declared in `<logging.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard, requires_capability(0x7f2e42419db8)]]
xref:BCLog/LogRateLimiter/Status.adoc[Status]
Consume(
    xref:SourceLocation.adoc[SourceLocation] const& source_loc,
    std::string const& str);
----

== Return Value

The suppression status for this location after consuming the string.

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

[cols="1,4"]
|===
| Name| Description
| *source_loc*
| The source location the log entry originates from.
| *str*
| The formatted log string whose size is charged against the location's budget.
|===


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