Skip to main content

DiskSpool

Struct DiskSpool 

Source
pub struct DiskSpool<R, S> { /* private fields */ }
Expand description

Durable write-ahead spool tier. See the module docs for the on-disk protocol and crash-recovery semantics.

Construction is infallible and does no I/O; the spool directory is created and leftover segments from a previous run are replayed downstream on the first ingest or flush call.

File I/O uses synchronous std::fs calls: appends are a few kilobytes plus an fsync, which is acceptable to block the runtime for at the collection rates this crate targets.

Implementations§

Source§

impl<R, S> DiskSpool<R, S>

Source

pub fn new(dir: impl Into<PathBuf>, policy: FlushPolicy, inner: S) -> Self

Create a spool rooted at dir. The pipeline name used when reconstructing WindowMeta for replayed segments is the last component of dir.

Source

pub fn with_pipeline_name(self, name: impl Into<String>) -> Self

Override the pipeline name derived from the directory.

Trait Implementations§

Source§

impl<R, S> Sink<R> for DiskSpool<R, S>
where R: Serialize + DeserializeOwned + Send + 'static, S: Sink<R>,

Source§

type Error = SpoolError<<S as Sink<R>>::Error>

Concrete error type (a thiserror enum, not a boxed error).
Source§

async fn ingest( &mut self, _meta: &WindowMeta, records: Vec<R>, ) -> Result<(), Self::Error>

Hand records to this layer. A buffering layer may hold them; a terminal sink ships them immediately.
Source§

async fn flush(&mut self) -> Result<(), Self::Error>

Force-drain this layer and everything downstream (shutdown, final flush, startup recovery).

Auto Trait Implementations§

§

impl<R, S> Freeze for DiskSpool<R, S>
where S: Freeze,

§

impl<R, S> RefUnwindSafe for DiskSpool<R, S>
where S: RefUnwindSafe,

§

impl<R, S> Send for DiskSpool<R, S>
where S: Send,

§

impl<R, S> Sync for DiskSpool<R, S>
where S: Sync,

§

impl<R, S> Unpin for DiskSpool<R, S>
where S: Unpin,

§

impl<R, S> UnsafeUnpin for DiskSpool<R, S>
where S: UnsafeUnpin,

§

impl<R, S> UnwindSafe for DiskSpool<R, S>
where S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> 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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, S> SinkExt<R> for S
where S: Sink<R>,

Source§

fn buffered(self, policy: FlushPolicy) -> Buffered<R, Self>

Wrap self in an in-memory buffering tier.
Source§

fn spooled( self, dir: impl Into<PathBuf>, policy: FlushPolicy, ) -> DiskSpool<R, Self>

Wrap self in a durable write-ahead spool rooted at dir. Read more
Source§

fn tee<B: Sink<R>>(self, other: B) -> Tee<Self, B>

Fan out: every batch is ingested into both self and other.
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