Skip to main content

BufferStats

Struct BufferStats 

Source
#[non_exhaustive]
pub struct BufferStats { pub pending_count: u64, pub latest_sequence: u64, pub head_sequence: u64, pub next_sequence: u64, pub approx_disk_bytes: u64, pub max_size_bytes: u64, pub store_pressure: f32, }
Expand description

Point-in-time snapshot of buffer state, captured atomically under a single lock acquisition so all fields are mutually consistent.

Returned by SegmentBuffer::stats. Useful for metrics endpoints or dashboards that need to observe multiple values without paying for several lock/unlock round-trips (and risking a torn read between calls).

This struct is #[non_exhaustive]: new fields may be added in any release without breaking semver. It is constructed internally by SegmentBuffer::stats; callers read fields via dot-syntax or pattern-match with .. only.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§pending_count: u64

Items waiting in the buffer (on-disk + in-memory pending). Same value as SegmentBuffer::pending_count.

§latest_sequence: u64

Highest sequence number assigned (or 0 if the buffer is empty). Same value as SegmentBuffer::latest_sequence.

§head_sequence: u64

Oldest unacknowledged sequence number (head_seq).

§next_sequence: u64

Next sequence number that will be assigned by the next successful SegmentBuffer::append (next_seq).

§approx_disk_bytes: u64

Approximate total bytes used by segment files on disk. Decreases when SegmentBuffer::delete_acked removes files.

§max_size_bytes: u64

Configured ceiling on disk usage (max_size_bytes). 0 disables the limit; in that case store_pressure is 0.0.

§store_pressure: f32

approx_disk_bytes / max_size_bytes, clamped to [0.0, 1.0]. 0.0 when no limit is configured.

Trait Implementations§

Source§

impl Clone for BufferStats

Source§

fn clone(&self) -> BufferStats

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BufferStats

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more