Skip to main content

StreamingSstWriter

Struct StreamingSstWriter 

Source
pub struct StreamingSstWriter<E: Entry> { /* private fields */ }
Expand description

A streaming SST file writer that writes blocks to disk incrementally.

Instead of materializing all entries in memory and then writing all value blocks followed by all key blocks, this writer interleaves block writes as entries arrive. Medium values are written immediately, small values are accumulated into blocks, and key blocks are flushed as soon as their value references are all resolved.

The SST reader is block-index-addressed (not file-position-addressed), so interleaving block types is fully compatible.

Implementations§

Source§

impl<E: Entry> StreamingSstWriter<E>

Source

pub fn new( file: &Path, flags: MetaEntryFlags, max_entry_count: u64, ) -> Result<Self>

Creates a new streaming SST writer.

max_entry_count is used to size the AMQF filter. It must be an upper bound on the number of entries that will be added; the filter is not resizable. A slightly oversized value only improves the false-positive rate.

Source

pub fn is_full(&self, max_entries: usize, max_data_size: usize) -> bool

Returns true if the SST file has reached capacity limits.

This is intended for compaction callers that need to split output across multiple SST files.

Source

pub fn add(&mut self, entry: E) -> Result<()>

Adds an entry to the SST file. Entries must be added in (key-hash, key) order.

Source

pub fn close(self) -> Result<(StaticSortedFileBuilderMeta<'static>, File)>

Finishes writing the SST file. Flushes remaining blocks, writes the index, and returns metadata.

Trait Implementations§

Source§

impl<E: Entry> Drop for StreamingSstWriter<E>

Available on debug-assertions enabled only.
Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<E> Freeze for StreamingSstWriter<E>

§

impl<E> RefUnwindSafe for StreamingSstWriter<E>
where E: RefUnwindSafe,

§

impl<E> Send for StreamingSstWriter<E>
where E: Send,

§

impl<E> Sync for StreamingSstWriter<E>
where E: Sync,

§

impl<E> Unpin for StreamingSstWriter<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for StreamingSstWriter<E>

§

impl<E> UnwindSafe for StreamingSstWriter<E>
where E: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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