Skip to main content

Collector

Struct Collector 

Source
pub struct Collector<K, V>
where K: Encode + Ord, V: Compress,
{ /* private fields */ }
Expand description

An ETL (extract, transform, load) data collector.

Data is pushed (extract) to the collector which internally flushes the data in a sorted (transform) manner to files of some specified capacity. the data can later be iterated over (load) in a sorted manner.

Used mainly to insert data into MDBX in a sorted manner. This is important because performance and storage space degrades greatly if the data is inserted unsorted (eg. tables with hashes as keys.) as opposed to append & sorted insert. Some benchmarks can be found here.

Implementations§

Source§

impl<K, V> Collector<K, V>
where K: Key, V: Value,

Source

pub const fn new( buffer_capacity_bytes: usize, parent_dir: Option<PathBuf>, ) -> Self

Create a new collector with some capacity.

Once the capacity (in bytes) is reached, the data is sorted and flushed to disk.

Source

pub const fn len(&self) -> usize

Returns number of elements currently in the collector.

Source

pub const fn is_empty(&self) -> bool

Returns true if there are currently no elements in the collector.

Source

pub fn clear(&mut self)

Clears the collector, removing all data, including the temporary directory.

Source

pub fn insert(&mut self, key: K, value: V) -> Result<()>

Insert an entry into the collector.

Source

pub fn iter(&mut self) -> Result<EtlIter<'_>>

Returns an iterator over the collector data.

The items of the iterator are sorted across all underlying files.

§Note

The keys and values have been pre-encoded, meaning they SHOULD NOT be encoded or compressed again.

Trait Implementations§

Source§

impl<K, V> Debug for Collector<K, V>
where K: Encode + Ord + Debug, V: Compress + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<K, V> Freeze for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: Freeze,

§

impl<K, V> RefUnwindSafe for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: RefUnwindSafe,

§

impl<K, V> Send for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: Send,

§

impl<K, V> Sync for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: Sync,

§

impl<K, V> Unpin for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: Unpin,

§

impl<K, V> UnsafeUnpin for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: UnsafeUnpin,

§

impl<K, V> UnwindSafe for Collector<K, V>
where Vec<(<K as Encode>::Encoded, <V as Compress>::Compressed)>: 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
§

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

§

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.

§

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
§

impl<T> MaybeDebug for T
where T: Debug,

§

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

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 120 bytes