sqll_sys/
lib.rs

1//! [<img alt="github" src="https://img.shields.io/badge/github-udoprog/sqll-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/sqll)
2//! [<img alt="crates.io" src="https://img.shields.io/crates/v/sqll-sys.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/sqll-sys)
3//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-sqll--sys-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/sqll-sys)
4//!
5//! Bindings to [sqlite] for [sqll].
6//!
7//! Note that the metadata field of this crate specified which version of sqlite
8//! is provided *if* the `bundled` feature is enabled, like `+sqlite-3.51.2`.
9//!
10//! <br>
11//!
12//! ## Features
13//!
14//! * `bundled` - Use the bundled sqlite3 source code. If this feature is not
15//!   enabled see the building with system dependencies section below.
16//! * `threadsafe` - Build sqlite3 with threadsafe support. If this is not set
17//!   then the `bundled` feature has to be set since we otherwise cannot control
18//!   how sqlite is built.
19//! * `strict` - Build sqlite3 with strict compiler flags enabled. This is only
20//!   used when the `bundled` feature is enabled.
21//!
22//! <br>
23//!
24//! ## Building
25//!
26//! When linking to a system sqlite library there is a minimum required version.
27//! This is specified in the [`sqlite3-version`] file and is checked at build
28//! time.
29//!
30//! If the `bundled` feature is not set, this will attempt to find the native
31//! sqlite3 bindings using the following methods:
32//! * Calling `vcpkg`, this can be disabled by setting the `NO_VCPKG` or
33//!   `SQLITE3_NO_VCPKG` environment variables.
34//! * Finding the library through `pkg-config`, this can be disabled by setting
35//!   or by setting the `SQLITE3_NO_PKG_CONFIG` environment variables.
36//!
37//! <br>
38//!
39//! ## Building under WASM
40//!
41//! If the target is is `wasm`, you can set the `SDK_PATH_ENV` to specify an SDK
42//! path to a particular compiler to use when building the wasm bindings. This
43//! is only supported when the `bundled` feature is enabled.
44//!
45//! The following environment variables can be set to modify this behavior:
46//! * `SQLL_TARGET` or `TARGET` to specify the build target. You probably want
47//!   to set this to something like `wasm32-wasi-unknown`.
48//! * `SQLL_CLANG_PATH` or `CLANG_PATH` to specify a custom path to a clang
49//!   compiler installation.
50//!
51//! [`sqlite3-version`]: https://github.com/udoprog/sqll/blob/main/sqll-sys/sqlite3-version
52//! [sqlite]: https://www.sqlite.org
53//! [sqll]: https://docs.rs/sqll
54
55#![no_std]
56
57#[allow(clippy::all, warnings)]
58mod base;
59pub use base::*;
60
61#[cfg(all(not(feature = "bundled"), not(feature = "threadsafe")))]
62compile_error!(
63    "sqll-sys: If the `threadsafe` feature is disabled, the `bundled` feature must be enabled. Otherwise it has no effect."
64);
sqll_sys/lib.rs

sqll_sys/
lib.rs
