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

Keeps track of an individual source location and how many available bytes are left for logging from it&period;

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct Stats;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BCLog/LogRateLimiter/Stats/2constructor.adoc[`Stats`]         [.small]#[constructor]#
| Construct with the initial number of available bytes&period;
| xref:BCLog/LogRateLimiter/Stats/Consume.adoc[`Consume`] 
| Updates internal accounting and returns true if enough available&lowbar;bytes were remaining
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BCLog/LogRateLimiter/Stats/m_available_bytes.adoc[`m&lowbar;available&lowbar;bytes`] 
| Remaining bytes
| xref:BCLog/LogRateLimiter/Stats/m_dropped_bytes.adoc[`m&lowbar;dropped&lowbar;bytes`] 
| Number of bytes that were consumed but didn&apos;t fit in the available bytes&period;
|===



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