harn-stdlib-artifacts 0.10.171

Precompiled Harn stdlib module artifacts for embedding in a host binary
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

//! Precompiled Harn stdlib module artifacts for a host binary.
//!
//! Without them, a host's first run on a new machine compiles every stdlib
//! module it imports and writes each one into the shared bytecode cache
//! (harn#9652). Link this crate and call [`register`] once at startup, before
//! the first Harn import, and those imports load from the binary instead.
//!
//! The artifacts are compiled by this crate's build script, with the same
//! harn-vm source the host links, when the `embed` feature is on. The host
//! also selects the harn-vm builtin families its own harn-vm resolves to
//! (`full`, or e.g. `sqlite` and `native-keyring`), because the builtin
//! contract is part of every artifact key. Without `embed` the table is empty
//! and [`register`] changes nothing.

pub use harn_vm::bytecode_cache::EmbeddedStdlibRegistrationError;

include!(concat!(env!("OUT_DIR"), "/stdlib_artifacts.rs"));

/// Register this binary's stdlib artifacts with the Harn loader.
///
/// # Errors
///
/// Refuses when a table is already registered in this process, and
/// [`EmbeddedStdlibRegistrationError::ForeignBuild`] when the table was
/// compiled with other harn-vm families than this binary runs, since every
/// import would then miss it and compile.
pub fn register() -> Result<(), EmbeddedStdlibRegistrationError> {
    harn_vm::bytecode_cache::register_embedded_stdlib_artifacts(ARTIFACTS)
}