Skip to main content

PayloadStore

Struct PayloadStore 

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

Payload storage engine

Architecture:

  • Append-only payload file (payload.data)
  • In-memory index: edge_id -> (offset, length, compression)
  • Memory-mapped reads for zero-copy access
  • Write-ahead log for crash recovery

Thread Safety:

  • Reads: Lock-free via memory map (multiple concurrent readers)
  • Writes: Serialized via RwLock (single writer)
  • Index: Protected by RwLock

SCALABILITY:

  • HashMap backend (default): Fast but uses ~50MB RAM per 1M payloads (32 bytes per entry + overhead). Suitable for < 10M traces.
  • DiskHash backend: Disk-backed hash table scales to billions with minimal RAM. Recommended for 10M+ traces.

Usage:

use sochdb_storage::payload::{PayloadStore, IndexBackend};

// Default: in-memory HashMap
let store = PayloadStore::open("./data").unwrap();

// For 10M+ scale: disk-backed hash table
let store = PayloadStore::open_with_backend("./data", IndexBackend::DiskHash).unwrap();

Implementations§

Source§

impl PayloadStore

Source

pub fn open<P: AsRef<Path>>(data_dir: P) -> Result<Self>

Open or create a payload store with default HashMap index

Source

pub fn open_with_backend<P: AsRef<Path>>( data_dir: P, backend: IndexBackend, ) -> Result<Self>

Open or create a payload store with specified index backend

Source

pub fn append( &self, edge_id: u128, data: &[u8], compression: Option<CompressionType>, ) -> Result<(u64, u32, u8)>

Append a payload and return (offset, length, compression_type)

Compression Strategy:

  • Small payloads (<1KB): No compression (overhead > benefit)
  • Medium payloads (1KB-100KB): LZ4 (fast compression/decompression)
  • Large payloads (>100KB): ZSTD (higher compression ratio)

This can be overridden by specifying compression_type explicitly.

DESKTOP APP FIX: Monitors memory growth and logs warnings at thresholds to prevent silent OOM in long-running sessions.

Source

pub fn get(&self, edge_id: u128) -> Result<Option<Vec<u8>>>

Get a payload by edge ID

Source

pub fn get_at_offset( &self, offset: u64, length: u32, compression: CompressionType, ) -> Result<Vec<u8>>

Get a payload at a specific offset

This is used when reading edges from SSTables that have embedded (offset, length, compression) tuples.

Source

pub fn has_payload(&self, edge_id: u128) -> bool

Check if a payload exists for an edge

Source

pub fn len(&self) -> usize

Get number of stored payloads

Source

pub fn is_empty(&self) -> bool

Check if empty

Source

pub fn save_index(&self) -> Result<()>

Save index to disk for fast recovery (delegates to backend)

Source

pub fn stats(&self) -> PayloadStats

Get statistics

Trait Implementations§

Source§

impl Drop for PayloadStore

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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<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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn vzip(self) -> V

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