flash-kv 0.2.1

A simple k/v store API inspired by bitcask
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

use std::{fmt::Debug, result};
use thiserror::Error;

#[derive(Error, Debug, PartialEq)]
pub enum Errors {
  #[error("failed to read from data file")]
  FailedToReadFromDataFile,

  #[error("failed to write to data file")]
  FailedToWriteToDataFile,

  #[error("failed to sync to data file")]
  FailedToSyncToDataFile,

  #[error("failed to open data file error")]
  FailedToOpenDataFile,

  #[error("the key is empty")]
  KeyIsEmpty,

  #[error("memory index failed to update")]
  IndexUpdateFailed,

  #[error("key is not found in database")]
  KeyNotFound,

  #[error("data file is not found in database")]
  DataFileNotFound,

  #[error("database dir path can not be empty")]
  DirPathIsEmpty,

  #[error("database data file size must be greater than 0")]
  DataFileSizeTooSmall,

  #[error("failed to create the database directory")]
  FailedToCreateDatabaseDir,

  #[error("failed to read the database directory")]
  FailedToReadDatabaseDir,

  #[error("database directory may be corrupted")]
  DatabaseDirectoryCorrupted,

  #[error("read data file eof")]
  ReadDataFileEOF,

  #[error("invalid crc value, log record maybe corrupted")]
  InvalidLogRecordCrc,

  #[error("exceed max batch number in one batch write")]
  ExceedMaxBatchNum,

  #[error("merge is in progress, try again later")]
  MergeInProgress,

  #[error("cannot use write batch, seq_no does not exist")]
  UnableToUseWriteBatch,

  #[error("the database directory is used by another process")]
  DatabaseIsUsing,

  #[error("invalid merge threshold value, must be in range (0, 1)")]
  InvalidMergeThreshold,

  #[error("merge threshold is unreached")]
  MergeThresholdUnreached,

  #[error("disk space is not enough for merge")]
  MergeNoEnoughSpace,

  #[error("failed to copy the database directory")]
  FailedToCopyDirectory,
}

pub type Result<T> = result::Result<T, Errors>;