[#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.

== Synopsis

Declared in `<logging.h>`

[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.
| xref:BCLog/LogRateLimiter/Stats/Consume.adoc[`Consume`] 
| Updates internal accounting and returns true if enough available_bytes were remaining
|===


== Data Members

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



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