Skip to content
Pre-release Bookclerk has not had a release yet. This site follows the development version, which changes often and may break your library. What that means
Bookclerk Docs
Features How it works Demo GitHub Download
Menu
Version Development (main) unstable
  • Development (main)From main
Overview
Use Bookclerk
  • Use Bookclerk
  • What is Bookclerk?
  • Getting started
  • Stores
  • Where your books go
  • Discover and wishlist
  • The web app
  • Listen in the web app
  • Sharing with your household
  • Join a library as a branch
  • Coming from Libation
  • Troubleshooting
  • Glossary
Run a server
  • Run a server
  • Running Bookclerk
  • Configuration
  • Security checklist
  • Database plugins
  • Stores reference
  • Output and destinations reference
  • Drop folders
  • Web app and sign-in reference
  • Integrations
  • Managing plugins
  • Libraries and branches
  • Notifications
  • Public address
  • Media worker pool
  • Uploads
  • Playback reference
  • Player apps
  • Backups, updates, import and export
  • Diagnostics & crash reports
  • CLI reference
  • Web API
Build plugins
  • Dynamic plugins
  • plugin.toml
  • Capabilities and consent
  • Entrypoints, events and the ABI
  • Plugin registry (crates.io taxonomy + install without Rust)
  • SQL contract
    • Bookclerk SQL contract v1
  • Working within database limits
  • Plugin SDKs
    • TypeScript plugin SDK
    • Python plugin SDK
    • Rust plugin SDK
How it works
  • How it works
  • Architecture
  • Discovery design
  • Embedding model benchmarks
  • Embedding model packs
  • Durable job queue
  • Bounded storage
  • The guest jail
  • bookclerk-workerd bridge transport
  • Node API and the live socket
  • One TLS backend
  • Windows AppContainer confinement notes
  • Rust crates
    • bookclerk_acquire
    • bookclerk_archive
    • bookclerk_audible_catalog
    • bookclerk_config
    • bookclerk_cover
    • bookclerk_db_exec
    • bookclerk_db_guest
    • bookclerk_db_testkit
    • bookclerk_demo_seed
    • bookclerk_dev
    • bookclerk_discover
    • bookclerk_enrich
    • bookclerk_intake
    • bookclerk_integrations
    • bookclerk_keystore
    • bookclerk_libav
    • bookclerk_library
    • bookclerk_media
    • bookclerk_migrate
    • bookclerk_model_pack
    • bookclerk_mp4
    • bookclerk_naming
    • bookclerk_node_client
    • bookclerk_node_proto
    • bookclerk_onnxruntime
    • bookclerk_player_api
    • bookclerk_player_engine
    • bookclerk_plugin_abi
    • bookclerk_plugin_ai_embedder
    • bookclerk_plugin_catalog
    • bookclerk_plugin_database_d1
    • bookclerk_plugin_database_postgres
    • bookclerk_plugin_database_sqlite
    • bookclerk_plugin_destination_b2
    • bookclerk_plugin_destination_local
    • bookclerk_plugin_destination_r2
    • bookclerk_plugin_destination_s3
    • bookclerk_plugin_e2e
    • bookclerk_plugin_echo_native_rust
    • bookclerk_plugin_echo_workerd_rust
    • bookclerk_plugin_host
    • bookclerk_plugin_manifest
    • bookclerk_plugin_source_audible
    • bookclerk_plugin_source_chirp
    • bookclerk_plugin_source_graphicaudio
    • bookclerk_plugin_source_libro
    • bookclerk_plugin_tools
    • bookclerk_resolve
    • bookclerk_sandbox
    • bookclerk_scan_delta
    • bookclerk_search
    • bookclerk_sentencepiece
    • bookclerk_source
    • bookclerk_storage
    • bookclerk_storefront
    • bookclerk_tags
    • bookclerk_tls
    • bookclerk_tray
    • bookclerk_window_policy
    • bookclerk_workerd
    • bookclerkd
Contribute
  • Contribute
  • Build from source and use the CLI
  • Dev Container
  • Web UI development
    • Visual and accessibility testing
  • Continuous integration
  • Fuzzing
  • Repository automation
  • Release packaging
  • Code documentation (Google style)
  • Writing docs
  • Licensing and the CLA
  • Research notes
    • Audiobook source candidates
    • Libation headless parity (reference)
Design decisions
  • Design decisions
  • ADR: Capability-driven plugin ABI v3
  • ADR: Workers RPC plugin ABI + per-jail embedded workerd
  • ADR: First-party identity (Operator / Owner / Administrator / Member)
  • ADR: Plugin-provided OIDC clients
  • Adapter-owned lowering over host-resolved SQL-v1
  • ADR: Schema state, unreleased development packs, and backups
  • ADR: Control plane — bootstrap, host identity, and database configuration
  • ADR: Every untrusted-input boundary is fuzzed
  • ADR: Security advisories are drafted only for what Bookclerk ships
  • ADR: Logging and tracing
  • ADR: Library data model (works, expressions, editions, holdings)
  • ADR: The Web API document is checked against the running daemon
  • ADR: Project licensing
  • ADR: Event delivery follows the Workers model
  • ADR: Library catalog network
  • ADR: Metadata claims and two-way sync with files
  • ADR: Chapters belong to the edition and are resolved from claims
  • ADR: Patron scopes and linked sign-in
  • ADR: Storage destinations are plugin instances
  • ADR: Uploads and ingest batches
  • ADR: What needs the operator, and what an Owner controls
  • ADR: Playback is a host feature with one core
  • ADR: The library key can live in the OS keychain
  • ADR: The desktop window is the person signed in to the computer
  • ADR: Public addresses come from ingress plugins
  • ADR: Notifications are routed by the host and sent by plugins
  • ADR: Drop folders are a host role on storage instances
  • ADR: The player API for apps at /player
  • ADR: Models run in plugins and are called through one AI binding
On this page
  • Constants
  • NAME
Version Development (main) unstable
  • Development (main)From main
Overview
Use Bookclerk
  • Use Bookclerk
  • What is Bookclerk?
  • Getting started
  • Stores
  • Where your books go
  • Discover and wishlist
  • The web app
  • Listen in the web app
  • Sharing with your household
  • Join a library as a branch
  • Coming from Libation
  • Troubleshooting
  • Glossary
Run a server
  • Run a server
  • Running Bookclerk
  • Configuration
  • Security checklist
  • Database plugins
  • Stores reference
  • Output and destinations reference
  • Drop folders
  • Web app and sign-in reference
  • Integrations
  • Managing plugins
  • Libraries and branches
  • Notifications
  • Public address
  • Media worker pool
  • Uploads
  • Playback reference
  • Player apps
  • Backups, updates, import and export
  • Diagnostics & crash reports
  • CLI reference
  • Web API
Build plugins
  • Dynamic plugins
  • plugin.toml
  • Capabilities and consent
  • Entrypoints, events and the ABI
  • Plugin registry (crates.io taxonomy + install without Rust)
  • SQL contract
    • Bookclerk SQL contract v1
  • Working within database limits
  • Plugin SDKs
    • TypeScript plugin SDK
    • Python plugin SDK
    • Rust plugin SDK
How it works
  • How it works
  • Architecture
  • Discovery design
  • Embedding model benchmarks
  • Embedding model packs
  • Durable job queue
  • Bounded storage
  • The guest jail
  • bookclerk-workerd bridge transport
  • Node API and the live socket
  • One TLS backend
  • Windows AppContainer confinement notes
  • Rust crates
    • bookclerk_acquire
    • bookclerk_archive
    • bookclerk_audible_catalog
    • bookclerk_config
    • bookclerk_cover
    • bookclerk_db_exec
    • bookclerk_db_guest
    • bookclerk_db_testkit
    • bookclerk_demo_seed
    • bookclerk_dev
    • bookclerk_discover
    • bookclerk_enrich
    • bookclerk_intake
    • bookclerk_integrations
    • bookclerk_keystore
    • bookclerk_libav
    • bookclerk_library
    • bookclerk_media
    • bookclerk_migrate
    • bookclerk_model_pack
    • bookclerk_mp4
    • bookclerk_naming
    • bookclerk_node_client
    • bookclerk_node_proto
    • bookclerk_onnxruntime
    • bookclerk_player_api
    • bookclerk_player_engine
    • bookclerk_plugin_abi
    • bookclerk_plugin_ai_embedder
    • bookclerk_plugin_catalog
    • bookclerk_plugin_database_d1
    • bookclerk_plugin_database_postgres
    • bookclerk_plugin_database_sqlite
    • bookclerk_plugin_destination_b2
    • bookclerk_plugin_destination_local
    • bookclerk_plugin_destination_r2
    • bookclerk_plugin_destination_s3
    • bookclerk_plugin_e2e
    • bookclerk_plugin_echo_native_rust
    • bookclerk_plugin_echo_workerd_rust
    • bookclerk_plugin_host
    • bookclerk_plugin_manifest
    • bookclerk_plugin_source_audible
    • bookclerk_plugin_source_chirp
    • bookclerk_plugin_source_graphicaudio
    • bookclerk_plugin_source_libro
    • bookclerk_plugin_tools
    • bookclerk_resolve
    • bookclerk_sandbox
    • bookclerk_scan_delta
    • bookclerk_search
    • bookclerk_sentencepiece
    • bookclerk_source
    • bookclerk_storage
    • bookclerk_storefront
    • bookclerk_tags
    • bookclerk_tls
    • bookclerk_tray
    • bookclerk_window_policy
    • bookclerk_workerd
    • bookclerkd
Contribute
  • Contribute
  • Build from source and use the CLI
  • Dev Container
  • Web UI development
    • Visual and accessibility testing
  • Continuous integration
  • Fuzzing
  • Repository automation
  • Release packaging
  • Code documentation (Google style)
  • Writing docs
  • Licensing and the CLA
  • Research notes
    • Audiobook source candidates
    • Libation headless parity (reference)
Design decisions
  • Design decisions
  • ADR: Capability-driven plugin ABI v3
  • ADR: Workers RPC plugin ABI + per-jail embedded workerd
  • ADR: First-party identity (Operator / Owner / Administrator / Member)
  • ADR: Plugin-provided OIDC clients
  • Adapter-owned lowering over host-resolved SQL-v1
  • ADR: Schema state, unreleased development packs, and backups
  • ADR: Control plane — bootstrap, host identity, and database configuration
  • ADR: Every untrusted-input boundary is fuzzed
  • ADR: Security advisories are drafted only for what Bookclerk ships
  • ADR: Logging and tracing
  • ADR: Library data model (works, expressions, editions, holdings)
  • ADR: The Web API document is checked against the running daemon
  • ADR: Project licensing
  • ADR: Event delivery follows the Workers model
  • ADR: Library catalog network
  • ADR: Metadata claims and two-way sync with files
  • ADR: Chapters belong to the edition and are resolved from claims
  • ADR: Patron scopes and linked sign-in
  • ADR: Storage destinations are plugin instances
  • ADR: Uploads and ingest batches
  • ADR: What needs the operator, and what an Owner controls
  • ADR: Playback is a host feature with one core
  • ADR: The library key can live in the OS keychain
  • ADR: The desktop window is the person signed in to the computer
  • ADR: Public addresses come from ingress plugins
  • ADR: Notifications are routed by the host and sent by plugins
  • ADR: Drop folders are a host role on storage instances
  • ADR: The player API for apps at /player
  • ADR: Models run in plugins and are called through one AI binding
  1. Docs
  2. How it works
  3. Rust crates
  4. bookclerk_plugin_abi
  5. methods
  6. bookclerk_plugin_abi::methods::health

bookclerk_plugin_abi::methods::health

Development These docs follow the development version and change with every merge.

Last updated Nov 6, 2026View as Markdown

Connectivity / configuration probe.

Result: crate::HealthOk.

Constants

NAME

pub const NAME: &str = "health";

Wire method name "health".

Generated from crates/bookclerk-plugin-abi at main · View as Markdown

On this page

  • Constants
  • NAME
  • Source on GitHub
  • Report a problem
Bookclerk Development version, built from 5e5ceea on 22 Nov 2026. Not yet released.
ProductFeaturesLive demoDownloadReleases
DocsGetting startedWriting pluginsArchitecture
ProjectGitHubSecurityPrivacySitemapcontact@bookclerk.app

Bookclerk is free software under the GNU AGPL, version 3 or later. Bookclerk and the Bookclerk logo are trademarks of the Bookclerk project. It is not affiliated with or endorsed by Audible, Libro.fm, Chirp or GraphicAudio; their names are trademarks of their owners. Bookclerk is meant for books you have bought, for your own listening.