pdf_oxide 0.3.24

The fastest Rust PDF library with text extraction: 0.8ms mean, 100% pass rate on 3,830 PDFs. 5× faster than pdf_extract, 17× faster than oxidize_pdf. Extract, create, and edit PDFs.
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
name: CI

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

# Cancel any in-progress run on the same branch when a new one starts.
# Saves minutes on force-pushes; main merges are unaffected (each push gets a unique ref).
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1

jobs:
  # Check formatting
  fmt:
    name: Format Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt

      - name: Check formatting
        run: cargo fmt -- --check

  # Linting with Clippy
  clippy:
    name: Clippy
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Run Clippy on full workspace
        run: cargo clippy --all-targets --workspace -- -D warnings

  # Build and test
  test:
    name: Test
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        rust: [stable, beta]
        include:
          # Nightly on Ubuntu only - catches upcoming Rust changes
          - os: ubuntu-latest
            rust: nightly
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.rust }}

      - name: Cache
        uses: Swatinem/rust-cache@v2
        with:
          key: ${{ matrix.rust }}

      - name: Build
        run: cargo build --verbose

      - name: Run tests
        run: cargo test --verbose

      - name: Build documentation
        run: cargo doc --no-deps

  # Test Python bindings feature (only production-ready feature in v0.1.0)
  features:
    name: Feature Tests
    runs-on: ubuntu-latest
    strategy:
      matrix:
        features:
          - ""
          - "python"
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Build with features
        run: cargo build --no-default-features --features "${{ matrix.features }}"
        if: matrix.features != ''

      - name: Build without features
        run: cargo build --no-default-features
        if: matrix.features == ''

  # CLI build
  cli:
    name: CLI Build
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Build CLI
        run: cargo build -p pdf_oxide_cli

      - name: Test CLI --help
        run: cargo run -p pdf_oxide_cli -- --help

  # MCP server build
  mcp:
    name: MCP Build
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Build MCP server
        run: cargo build -p pdf_oxide_mcp

  # Python bindings test
  python:
    name: Python Bindings
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]

    steps:
      - uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Create virtual environment
        run: uv venv

      - name: Install maturin
        run: uv pip install maturin pytest

      - name: Build Python package
        run: uv run maturin build --release --features python --out dist

      - name: Install wheel
        shell: bash
        run: |
          wheel=$(ls dist/*.whl)
          uv pip install "$wheel"

      - name: Test Python bindings
        run: uv run python -c "import pdf_oxide; print(pdf_oxide.VERSION)"

  # WASM build check
  wasm-build:
    name: WASM Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: wasm32-unknown-unknown
          components: clippy

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Build WASM
        run: cargo build --lib --target wasm32-unknown-unknown --features wasm

      - name: Clippy WASM
        run: cargo clippy --target wasm32-unknown-unknown --no-default-features --features wasm --lib -- -D warnings

  # C FFI layer build check - the shared library that Go, JS, and C# bindings link against
  ffi-build:
    name: FFI Build (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache
        uses: Swatinem/rust-cache@v2
        with:
          key: ffi-${{ matrix.os }}

      - name: Build library (produces cdylib + rlib)
        run: cargo build --release --lib

  # Go bindings build and test
  go:
    name: Go Bindings (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.22'

      - name: Cache
        uses: Swatinem/rust-cache@v2
        with:
          key: go-${{ matrix.os }}

      - name: Build library (produces cdylib + rlib)
        run: cargo build --release --lib

      - name: Stage native lib for Go
        shell: bash
        run: |
          case "${{ matrix.os }}" in
            ubuntu-latest)
              mkdir -p go/lib/linux_amd64
              cp target/release/libpdf_oxide.so go/lib/linux_amd64/
              ;;
            macos-latest)
              mkdir -p go/lib/darwin_arm64
              cp target/release/libpdf_oxide.dylib go/lib/darwin_arm64/
              ;;
            windows-latest)
              mkdir -p go/lib/windows_amd64
              cp target/release/pdf_oxide.dll go/lib/windows_amd64/
              ;;
          esac

      - name: Go build
        working-directory: go
        run: go build ./...

      - name: Go vet
        working-directory: go
        run: go vet ./...

      - name: Go format check
        working-directory: go
        shell: bash
        run: |
          diff=$(gofmt -l .)
          if [ -n "$diff" ]; then
            echo "The following Go files need formatting:"
            echo "$diff"
            echo
            echo "Run 'gofmt -w .' to fix."
            exit 1
          fi

  # JavaScript/TypeScript bindings build and test
  nodejs:
    name: Node.js Bindings (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Set up Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '20'

      - name: Cache
        uses: Swatinem/rust-cache@v2
        with:
          key: nodejs-${{ matrix.os }}

      - name: Build library (produces cdylib + rlib)
        run: cargo build --release --lib

      - name: Install dependencies
        working-directory: js
        run: npm install --ignore-scripts

      - name: TypeScript type check
        working-directory: js
        run: npx tsc --noEmit

  # C#/.NET bindings build
  csharp:
    name: C# Bindings (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Set up .NET
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: '8.0.x'

      - name: Cache
        uses: Swatinem/rust-cache@v2
        with:
          key: csharp-${{ matrix.os }}

      - name: Build library (produces cdylib + rlib)
        run: cargo build --release --lib

      - name: Build C# library
        working-directory: csharp/PdfOxide
        run: dotnet build -c Release -p:TreatWarningsAsErrors=true

      - name: Build C# tests
        working-directory: csharp/PdfOxide.Tests
        run: dotnet build -c Release -p:TreatWarningsAsErrors=true

      - name: Stage native lib for C# tests
        shell: bash
        run: |
          case "${{ matrix.os }}" in
            ubuntu-latest)
              cp target/release/libpdf_oxide.so csharp/PdfOxide.Tests/bin/Release/net8.0/
              ;;
            macos-latest)
              cp target/release/libpdf_oxide.dylib csharp/PdfOxide.Tests/bin/Release/net8.0/
              ;;
            windows-latest)
              cp target/release/pdf_oxide.dll csharp/PdfOxide.Tests/bin/Release/net8.0/
              ;;
          esac

      - name: Run C# tests
        working-directory: csharp/PdfOxide.Tests
        run: dotnet test -c Release --no-build --verbosity normal

  # Code coverage with enforcement
  coverage:
    name: Code Coverage
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: llvm-tools-preview

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov

      - name: Generate coverage
        run: |
          cargo llvm-cov --lib --tests --lcov --output-path lcov.info \
            --ignore-filename-regex '(cid_mappings/|adobe_glyph_list\.rs|python\.rs|wasm\.rs|ffi\.rs|ocr/|rendering/|bin/)'

      - name: Enforce 85% coverage threshold
        run: |
          cargo llvm-cov report \
            --ignore-filename-regex '(cid_mappings/|adobe_glyph_list\.rs|python\.rs|wasm\.rs|ffi\.rs|ocr/|rendering/|bin/)' \
            --fail-under-lines 85

      - name: Upload coverage to Codecov
        if: always()
        uses: codecov/codecov-action@v6
        with:
          files: ./lcov.info
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false

  # Benchmark smoke test
  bench:
    name: Benchmark Smoke Test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache
        uses: Swatinem/rust-cache@v2

      - name: Build benchmarks
        run: cargo bench --no-run

  # Security audit
  audit:
    name: Security Audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Run security audit
        uses: actions-rust-lang/audit@v1

  # Check dependencies are up to date
  deny:
    name: Dependency Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Check dependencies
        uses: EmbarkStudios/cargo-deny-action@v2
        with:
          arguments: ""