Struct ValueLog

pub struct ValueLog<I, A, C = Crc32> { /* private fields */ }

The value log implementation.

Trait Implementations

impl<I: Clone, A: Clone, C: Clone> Clone for ValueLog<I, A, C>

fn clone(&self) -> ValueLog<I, A, C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Debug, A: Debug, C: Debug> Debug for ValueLog<I, A, C>

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

Formats the value using the given formatter.

impl<T, I, A, C> From<ValueLog<I, A, C>> for GenericValueLog<T, I, A, C>

fn from(value: ValueLog<I, A, C>) -> Self

Converts to this type from the input type.

impl<I, A, C> Log for ValueLog<I, A, C>

where A: Allocator, C: BuildChecksumer,

type Id = I

The identifier type (file ID) for the log.

fn checksum(&self, bytes: &[u8]) -> u64

Calculates the checksum of the given bytes.

fn options(&self) -> &Options

Returns the options of the log.

fn id(&self) -> &Self::Id

Returns the identifier of the log.

fn magic_version(&self) -> u16

Returns the magic version of the log.

fn version(&self) -> u16

Returns the version of the log.

fn discarded(&self) -> u32

Returns the discarded bytes of the log.

fn data_offset(&self) -> usize

Returns the data offset of the log.

fn path(&self) -> Option<&<Self::Allocator as Allocator>::Path>

Available on crate feature memmap and non-target_family="wasm" only.

Returns the path of the log.

fn in_memory(&self) -> bool

Returns true if the log is in memory.

fn on_disk(&self) -> bool

Returns true if the log is on disk.

fn is_map(&self) -> bool

Available on crate feature memmap and non-target_family="wasm" only.

Returns true if the log is using a memory map backend.

unsafe fn reserved_slice(&self) -> &[u8]

Returns the reserved space in the WAL.

fn lock_exclusive(&self) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

Locks the underlying file for exclusive access, only works on mmap with a file backend.

fn lock_shared(&self) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

Locks the underlying file for shared access, only works on mmap with a file backend.

fn unlock(&self) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

Unlocks the underlying file, only works on mmap with a file backend.

unsafe fn mlock(&self, offset: usize, len: usize) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

mlock(ptr, len)—Lock memory into RAM.

unsafe fn munlock(&self, offset: usize, len: usize) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

munlock(ptr, len)—Unlock memory.

impl<I, A, C> LogReader for ValueLog<I, A, C>

where C: BuildChecksumer, A: Allocator,

unsafe fn read( &self, id: &Self::Id, offset: u32, len: u32, ) -> Result<&[u8], Error>

where Self::Id: Eq,

Reads a value from the log.

impl<I, A, C> LogWriter for ValueLog<I, A, C>

where A: Allocator, C: BuildChecksumer, I: CheapClone + Debug,

fn insert(&self, value: &[u8]) -> Result<ValuePointer<Self::Id>, Error>

where Self::Id: CheapClone + Debug,

Inserts a value into the log.

fn insert_tombstone( &self, value: &[u8], ) -> Result<ValuePointer<Self::Id>, Error>

where Self::Id: CheapClone + Debug,

Inserts a tombstone value into the log.

impl<I, A, C> Mutable for ValueLog<I, A, C>