Skip to main content

CompactionAuditSink

Struct CompactionAuditSink 

Source
pub struct CompactionAuditSink { /* private fields */ }
Expand description

Async bounded-mpsc audit sink for compaction records.

The sink serialises CompactedPageRecord values to a JSONL file via a background writer task, mirroring the zeph-tools audit pattern. Dropped records (when the channel is full) are counted and logged.

§Invariant

CompactionAuditSink::flush sends a rendezvous sentinel through the channel and awaits the writer task’s confirmation with a 100 ms timeout. Records accepted into the channel before flush is called are guaranteed to be written before the flush responder fires.

§Examples

use zeph_context::typed_page::CompactionAuditSink;
use std::path::Path;

let sink = CompactionAuditSink::open(Path::new(".local/audit/compaction.jsonl"), 256)
    .await
    .unwrap();

Implementations§

Source§

impl CompactionAuditSink

Source

pub async fn open(path: &Path, capacity: usize) -> Result<Self, Error>

Open a new audit sink writing to path.

capacity is the bounded channel depth; records dropped when full are counted in the internal drop counter and logged at WARN.

§Errors

Returns an error when path cannot be opened for appending.

Source

pub fn send(&self, record: CompactedPageRecord)

Send a record to the audit sink.

If the channel is full the record is dropped and the drop counter is incremented.

Source

pub async fn flush(&self)

Flush all pending records with bounded 100 ms timeout.

Sends a Flush sentinel through the same channel as records, so ordering is preserved — the writer task responds only after all preceding records are written. If the writer task does not respond within 100 ms, the flush times out silently.

Source

pub fn dropped_count(&self) -> u64

Number of records dropped due to a full channel.

Trait Implementations§

Source§

impl Clone for CompactionAuditSink

Source§

fn clone(&self) -> CompactionAuditSink

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 CompactionAuditSink

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<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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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