pub struct StreamChangelogBuffer { /* private fields */ }Expand description
A pre-allocated ring buffer for changelog entries.
Uses a simple write/read index scheme. Not thread-safe on its own —
intended to be used behind the StreamCheckpointManager mutex.
Implementations§
Source§impl StreamChangelogBuffer
impl StreamChangelogBuffer
Sourcepub fn new(capacity: usize, policy: OverflowPolicy) -> Self
pub fn new(capacity: usize, policy: OverflowPolicy) -> Self
Creates a new changelog buffer with the given capacity.
Sourcepub fn push(&mut self, entry: StreamChangelogEntry) -> bool
pub fn push(&mut self, entry: StreamChangelogEntry) -> bool
Pushes an entry into the buffer.
Returns true if the entry was stored, false if dropped due to
overflow policy.
Sourcepub fn pop(&mut self) -> Option<StreamChangelogEntry>
pub fn pop(&mut self) -> Option<StreamChangelogEntry>
Pops the oldest entry from the buffer.
Sourcepub fn drain(&mut self, max: usize, out: &mut Vec<StreamChangelogEntry>)
pub fn drain(&mut self, max: usize, out: &mut Vec<StreamChangelogEntry>)
Drains up to max entries into the provided vector.
Sourcepub fn drain_all(&mut self, out: &mut Vec<StreamChangelogEntry>)
pub fn drain_all(&mut self, out: &mut Vec<StreamChangelogEntry>)
Drains all entries into the provided vector.
Sourcepub fn overflow_count(&self) -> u64
pub fn overflow_count(&self) -> u64
Returns the total number of overflows since creation.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for StreamChangelogBuffer
impl RefUnwindSafe for StreamChangelogBuffer
impl Send for StreamChangelogBuffer
impl Sync for StreamChangelogBuffer
impl Unpin for StreamChangelogBuffer
impl UnwindSafe for StreamChangelogBuffer
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.