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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

name: Rust CI

on:
  push:
    branches: ['*'] 
    paths-ignore:   
      # Don't run Clippy tests, when only textfiles were modified 
      - 'README.md'
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**/*.md'
      - '**/*.txt'
      - '.gitignore'
  pull_request:
    paths-ignore:  
      # Don't run Clippy tests, when only textfiles were modified  
      - 'README.md'
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**/*.md'
      - '**/*.txt'
      - '.gitignore'
  workflow_dispatch: 

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -Dwarnings
  RUST_BACKTRACE: 1

jobs:
  rustfmt:
    name: rustfmt
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust stable
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true
          components: rustfmt
      - uses: Swatinem/rust-cache@v2
      - name: Check formatting
        run: cargo fmt --all -- --check
        continue-on-error: true

  clippy:
    name: clippy
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust stable
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true
          components: clippy
      - uses: Swatinem/rust-cache@v2
      - name: Apply clippy lints
        run: cargo clippy --all-features -- -D warnings

  unit-tests:
    name: unit tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install latest nightly
        uses: actions-rs/toolchain@v1
        with:
          toolchain: nightly
          override: true

      # Use Swatinem/rust-cache@v2 for caching
      - uses: Swatinem/rust-cache@v2

      # Install cargo-nextest
      - name: Install cargo-nextest
        uses: taiki-e/install-action@v2
        with:
          tool: cargo-nextest

      - name: Test all features
        # Run sequentially to avoid race condition around file system size
        # Add timeout via GitHub Actions step property
        timeout-minutes: 5 # 300 seconds
        # Use cargo nextest run instead of cargo test
        run: cargo nextest run --all-features 

  coverage:
    name: cargo tarpaulin
    runs-on: ubuntu-latest
    needs:
      - unit-tests
      - clippy
      - rustfmt
    steps:
      - uses: actions/checkout@v4
      - name: Install latest nightly
        uses: actions-rs/toolchain@v1
        with:
          toolchain: nightly
          override: true
      - name: Install cargo-tarpaulin
        run: cargo install cargo-tarpaulin --version 0.27.3
      - uses: Swatinem/rust-cache@v2
      - name: Run tarpaulin
        run: cargo tarpaulin --all-features --run-types tests --run-types doctests --workspace --out xml -- --test-threads 1
      - name: Upload to codecov.io
        uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: true

  docs:
    name: Generate Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions-rs/toolchain@v1
        with:
          toolchain: nightly
          override: true
      - uses: Swatinem/rust-cache@v2
      - name: Generate documentation
        run: cargo doc --lib --no-deps --all-features --document-private-items
        env:
          RUSTFLAGS: ${{ env.RUSTFLAGS }} --cfg docsrs
          RUSTDOCFLAGS: --cfg docsrs -Dwarnings